From c32965c0c4a5975ba37371ecd819d9cffb080aa5 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:31:16 -0500 Subject: [PATCH] fix: [Many APIs] fix typings for IAM methods (#4460) * 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJleW9uZGNvcnAtY2xpZW50Z2F0ZXdheXMvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWFuYWx5dGljc2h1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWNvbm5lY3Rpb24vLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWRhdGFleGNoYW5nZS8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWRhdGFwb2xpY2llcy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LWRhdGF0cmFuc2Zlci8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpZ3F1ZXJ5LXJlc2VydmF0aW9uLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbGxpbmctYnVkZ2V0cy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbGxpbmcvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbmFyeWF1dGhvcml6YXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNlcnRpZmljYXRlbWFuYWdlci8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNoYW5uZWwvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNsb3VkZG1zLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNvbnRhY3RjZW50ZXJpbnNpZ2h0cy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNvbnRlbnR3YXJlaG91c2UvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFjYXRhbG9nLWxpbmVhZ2UvLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFjYXRhbG9nLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFmb3JtLy5Pd2xCb3QueWFtbCIsImgiOiI4YmVjMDY2NDkyYTZkYTI4NTViMWI4Y2U1NjI2NjRjMGE2YjMwYjAxIn0= Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFmdXNpb24vLk93bEJvdC55YW1sIiwiaCI6IjhiZWMwNjY0OTJhNmRhMjg1NWIxYjhjZTU2MjY2NGMwYTZiMzBiMDEifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFsYWJlbGluZy8uT3dsQm90LnlhbWwiLCJoIjoiOGJlYzA2NjQ5MmE2ZGEyODU1YjFiOGNlNTYyNjY0YzBhNmIzMGIwMSJ9 * run the bootstrapper * chore!: update to Node 14 --------- Co-authored-by: Owl Bot Co-authored-by: Sofia Leon --- .../README.md | 15 +- .../package.json | 11 +- .../samples/README.md | 18 - ...le.cloud.beyondcorp.clientgateways.v1.json | 2 +- ...le.cloud.beyondcorp.clientgateways.v1.json | 215 ++ .../samples/package.json | 4 +- .../src/v1/client_gateways_service_client.ts | 56 +- .../system-test/install.ts | 97 +- .../README.md | 37 +- .../package.json | 11 +- .../samples/README.md | 18 - ...lytics_hub_service.test_iam_permissions.js | 2 +- ...google.cloud.bigquery.analyticshub.v1.json | 2 +- ...google.cloud.bigquery.analyticshub.v1.json | 683 +++++ .../samples/package.json | 4 +- .../src/v1/analytics_hub_service_client.ts | 111 +- .../package.json | 11 +- ...connection_service.test_iam_permissions.js | 2 +- ...a_google.cloud.bigquery.connection.v1.json | 375 +++ ...connection_service.test_iam_permissions.js | 2 +- ...gle.cloud.bigquery.connection.v1beta1.json | 419 +++ .../samples/package.json | 4 +- .../src/v1/connection_service_client.ts | 52 +- .../src/v1beta1/connection_service_client.ts | 45 +- .../README.md | 37 +- .../package.json | 11 +- .../samples/README.md | 18 - ...lytics_hub_service.test_iam_permissions.js | 2 +- ...e.cloud.bigquery.dataexchange.v1beta1.json | 2 +- ...e.cloud.bigquery.dataexchange.v1beta1.json | 683 +++++ .../samples/package.json | 4 +- .../v1beta1/analytics_hub_service_client.ts | 119 +- .../README.md | 41 +- .../package.json | 11 +- .../samples/README.md | 18 - ...ata_policy_service.test_iam_permissions.js | 2 +- ...google.cloud.bigquery.datapolicies.v1.json | 2 +- ...google.cloud.bigquery.datapolicies.v1.json | 415 +++ ...ata_policy_service.test_iam_permissions.js | 2 +- ...e.cloud.bigquery.datapolicies.v1beta1.json | 2 +- ...e.cloud.bigquery.datapolicies.v1beta1.json | 367 +++ .../samples/package.json | 4 +- .../src/v1/data_policy_service_client.ts | 57 +- .../src/v1beta1/data_policy_service_client.ts | 52 +- .../README.md | 37 +- .../package.json | 11 +- .../samples/README.md | 18 - ...ta_transfer_service.enroll_data_sources.js | 2 +- ..._transfer_service.list_transfer_configs.js | 2 +- ...ata_transfer_service.list_transfer_logs.js | 2 +- ...ata_transfer_service.list_transfer_runs.js | 2 +- ...google.cloud.bigquery.datatransfer.v1.json | 2 +- ...google.cloud.bigquery.datatransfer.v1.json | 715 +++++ .../samples/package.json | 4 +- .../src/v1/data_transfer_service_client.ts | 131 +- .../README.md | 49 +- .../package.json | 11 +- .../samples/README.md | 18 - ...tion_service.merge_capacity_commitments.js | 2 +- ....google.cloud.bigquery.reservation.v1.json | 2 +- ..._google.cloud.bigquery.reservation.v1.json | 967 +++++++ .../samples/package.json | 2 +- .../src/v1/reservation_service_client.ts | 165 +- .../google-cloud-billing-budgets/package.json | 9 +- ...adata_google.cloud.billing.budgets.v1.json | 231 ++ ..._google.cloud.billing.budgets.v1beta1.json | 231 ++ .../samples/package.json | 4 +- .../src/v1/budget_service_client.ts | 37 +- .../src/v1beta1/budget_service_client.ts | 37 +- packages/google-cloud-billing/package.json | 11 +- .../v1/cloud_billing.test_iam_permissions.js | 2 +- ...ppet_metadata_google.cloud.billing.v1.json | 563 ++++ .../google-cloud-billing/samples/package.json | 4 +- .../src/v1/cloud_billing_client.ts | 74 +- .../src/v1/cloud_catalog_client.ts | 34 +- .../README.md | 41 +- .../package.json | 11 +- .../samples/README.md | 18 - ...a.google.cloud.binaryauthorization.v1.json | 2 +- ...a_google.cloud.binaryauthorization.v1.json | 403 +++ ...gle.cloud.binaryauthorization.v1beta1.json | 2 +- ...gle.cloud.binaryauthorization.v1beta1.json | 351 +++ .../samples/package.json | 4 +- .../binauthz_management_service_v1_client.ts | 115 +- .../src/v1/system_policy_v1_client.ts | 5 +- .../src/v1/validation_helper_v1_client.ts | 17 +- ...uthz_management_service_v1_beta1_client.ts | 115 +- .../v1beta1/system_policy_v1_beta1_client.ts | 5 +- .../google-cloud-certificatemanager/README.md | 55 +- .../package.json | 11 +- .../samples/README.md | 18 - ...ta.google.cloud.certificatemanager.v1.json | 2 +- ...ta_google.cloud.certificatemanager.v1.json | 1111 ++++++++ .../samples/package.json | 4 +- .../src/v1/certificate_manager_client.ts | 202 +- packages/google-cloud-channel/package.json | 11 +- ...el_reports_service.fetch_report_results.js | 2 +- .../v1/cloud_channel_service.change_offer.js | 2 +- ...cloud_channel_service.change_parameters.js | 2 +- ...d_channel_service.transfer_entitlements.js | 2 +- ...service.transfer_entitlements_to_google.js | 2 +- ...ppet_metadata_google.cloud.channel.v1.json | 2479 +++++++++++++++++ .../google-cloud-channel/samples/package.json | 4 +- .../cloud_channel_reports_service_client.ts | 78 +- .../src/v1/cloud_channel_service_client.ts | 761 +++-- packages/google-cloud-clouddms/package.json | 11 +- ..._migration_service.import_mapping_rules.js | 2 +- ...pet_metadata_google.cloud.clouddms.v1.json | 1739 ++++++++++++ .../samples/package.json | 2 +- .../src/v1/data_migration_service_client.ts | 289 +- .../package.json | 11 +- ...google.cloud.contactcenterinsights.v1.json | 1695 +++++++++++ .../samples/package.json | 2 +- .../src/v1/contact_center_insights_client.ts | 251 +- .../google-cloud-contentwarehouse/README.md | 61 +- .../package.json | 11 +- .../samples/README.md | 18 - .../v1/document_service.search_documents.js | 2 +- ...data.google.cloud.contentwarehouse.v1.json | 2 +- ...data_google.cloud.contentwarehouse.v1.json | 1283 +++++++++ .../samples/package.json | 4 +- .../src/v1/document_link_service_client.ts | 32 +- .../src/v1/document_schema_service_client.ts | 39 +- .../src/v1/document_service_client.ts | 90 +- .../src/v1/rule_set_service_client.ts | 37 +- .../src/v1/synonym_set_service_client.ts | 37 +- .../README.md | 39 +- .../package.json | 11 +- .../samples/README.md | 18 - .../v1/lineage.batch_search_link_processes.js | 2 +- ...a.google.cloud.datacatalog.lineage.v1.json | 2 +- ...a_google.cloud.datacatalog.lineage.v1.json | 755 +++++ .../samples/package.json | 4 +- .../src/v1/lineage_client.ts | 146 +- .../google-cloud-datacatalog/package.json | 11 +- .../v1/data_catalog.reconcile_tags.js | 2 +- .../v1/data_catalog.test_iam_permissions.js | 2 +- ...policy_tag_manager.test_iam_permissions.js | 2 +- ...manager_serialization.export_taxonomies.js | 2 +- ..._metadata_google.cloud.datacatalog.v1.json | 2275 +++++++++++++++ .../data_catalog.test_iam_permissions.js | 2 +- ...policy_tag_manager.test_iam_permissions.js | 2 +- ...manager_serialization.export_taxonomies.js | 2 +- ...data_google.cloud.datacatalog.v1beta1.json | 1947 +++++++++++++ .../samples/package.json | 4 +- .../src/v1/data_catalog_client.ts | 278 +- .../src/v1/policy_tag_manager_client.ts | 89 +- ...policy_tag_manager_serialization_client.ts | 15 +- .../src/v1beta1/data_catalog_client.ts | 220 +- .../src/v1beta1/policy_tag_manager_client.ts | 89 +- ...policy_tag_manager_serialization_client.ts | 10 +- packages/google-cloud-dataform/README.md | 151 +- packages/google-cloud-dataform/package.json | 11 +- .../google-cloud-dataform/samples/README.md | 18 - .../dataform.commit_workspace_changes.js | 2 +- .../dataform.reset_workspace_changes.js | 2 +- .../generated/v1alpha2/dataform.write_file.js | 2 +- ...tadata.google.cloud.dataform.v1alpha2.json | 2 +- ...tadata_google.cloud.dataform.v1alpha2.json | 1647 +++++++++++ .../dataform.commit_workspace_changes.js | 2 +- .../dataform.reset_workspace_changes.js | 2 +- .../generated/v1beta1/dataform.write_file.js | 2 +- ...etadata.google.cloud.dataform.v1beta1.json | 2 +- ...etadata_google.cloud.dataform.v1beta1.json | 1647 +++++++++++ .../samples/package.json | 4 +- .../src/v1alpha2/dataform_client.ts | 284 +- .../src/v1beta1/dataform_client.ts | 284 +- packages/google-cloud-datafusion/README.md | 47 +- packages/google-cloud-datafusion/package.json | 11 +- .../google-cloud-datafusion/samples/README.md | 18 - ...t_metadata.google.cloud.datafusion.v1.json | 2 +- ...t_metadata_google.cloud.datafusion.v1.json | 335 +++ ...adata.google.cloud.datafusion.v1beta1.json | 2 +- ...adata_google.cloud.datafusion.v1beta1.json | 603 ++++ .../samples/package.json | 4 +- .../src/v1/data_fusion_client.ts | 63 +- .../src/v1beta1/data_fusion_client.ts | 118 +- packages/google-cloud-datalabeling/README.md | 75 +- .../google-cloud-datalabeling/package.json | 11 +- .../samples/README.md | 18 - ...ata.google.cloud.datalabeling.v1beta1.json | 2 +- ...ata_google.cloud.datalabeling.v1beta1.json | 1591 +++++++++++ .../samples/package.json | 4 +- .../v1beta1/data_labeling_service_client.ts | 398 ++- 184 files changed, 28395 insertions(+), 3775 deletions(-) create mode 100644 packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientgateways.v1.json create mode 100644 packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata_google.cloud.bigquery.analyticshub.v1.json create mode 100644 packages/google-cloud-bigquery-connection/samples/generated/v1/snippet_metadata_google.cloud.bigquery.connection.v1.json create mode 100644 packages/google-cloud-bigquery-connection/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.connection.v1beta1.json create mode 100644 packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json create mode 100644 packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json create mode 100644 packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json create mode 100644 packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json create mode 100644 packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata_google.cloud.bigquery.reservation.v1.json create mode 100644 packages/google-cloud-billing-budgets/samples/generated/v1/snippet_metadata_google.cloud.billing.budgets.v1.json create mode 100644 packages/google-cloud-billing-budgets/samples/generated/v1beta1/snippet_metadata_google.cloud.billing.budgets.v1beta1.json create mode 100644 packages/google-cloud-billing/samples/generated/v1/snippet_metadata_google.cloud.billing.v1.json create mode 100644 packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata_google.cloud.binaryauthorization.v1.json create mode 100644 packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json create mode 100644 packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata_google.cloud.certificatemanager.v1.json create mode 100644 packages/google-cloud-channel/samples/generated/v1/snippet_metadata_google.cloud.channel.v1.json create mode 100644 packages/google-cloud-clouddms/samples/generated/v1/snippet_metadata_google.cloud.clouddms.v1.json create mode 100644 packages/google-cloud-contactcenterinsights/samples/generated/v1/snippet_metadata_google.cloud.contactcenterinsights.v1.json create mode 100644 packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata_google.cloud.contentwarehouse.v1.json create mode 100644 packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.lineage.v1.json create mode 100644 packages/google-cloud-datacatalog/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.v1.json create mode 100644 packages/google-cloud-datacatalog/samples/generated/v1beta1/snippet_metadata_google.cloud.datacatalog.v1beta1.json create mode 100644 packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata_google.cloud.dataform.v1alpha2.json create mode 100644 packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata_google.cloud.dataform.v1beta1.json create mode 100644 packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata_google.cloud.datafusion.v1.json create mode 100644 packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata_google.cloud.datafusion.v1beta1.json create mode 100644 packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata_google.cloud.datalabeling.v1beta1.json diff --git a/packages/google-cloud-beyondcorp-clientgateways/README.md b/packages/google-cloud-beyondcorp-clientgateways/README.md index ff166021614..f4aec42b3b6 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/README.md +++ b/packages/google-cloud-beyondcorp-clientgateways/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-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/clientgateways.svg)](https://www.npmjs.org/package/@google-cloud/clientgateways) @@ -112,16 +112,15 @@ callListClientGateways(); ## 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_gateways_service.create_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.create_client_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-clientgateways/samples/generated/v1/client_gateways_service.create_client_gateway.js,samples/README.md) | -| Client_gateways_service.delete_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.delete_client_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-clientgateways/samples/generated/v1/client_gateways_service.delete_client_gateway.js,samples/README.md) | -| Client_gateways_service.get_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.get_client_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-clientgateways/samples/generated/v1/client_gateways_service.get_client_gateway.js,samples/README.md) | -| Client_gateways_service.list_client_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.list_client_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-clientgateways/samples/generated/v1/client_gateways_service.list_client_gateways.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/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-clientgateways/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/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-clientgateways/samples/test/quickstart.js,samples/README.md) | +| Client_gateways_service.create_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.create_client_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-clientgateways/samples/generated/v1/client_gateways_service.create_client_gateway.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_gateways_service.delete_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.delete_client_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-clientgateways/samples/generated/v1/client_gateways_service.delete_client_gateway.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_gateways_service.get_client_gateway | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.get_client_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-clientgateways/samples/generated/v1/client_gateways_service.get_client_gateway.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | +| Client_gateways_service.list_client_gateways | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/client_gateways_service.list_client_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-clientgateways/samples/generated/v1/client_gateways_service.list_client_gateways.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-clientgateways/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-clientgateways/samples/quickstart.js,packages/google-cloud-beyondcorp-clientgateways/samples/README.md) | diff --git a/packages/google-cloud-beyondcorp-clientgateways/package.json b/packages/google-cloud-beyondcorp-clientgateways/package.json index b9164ba5207..5db7c3c14f1 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/package.json +++ b/packages/google-cloud-beyondcorp-clientgateways/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-clientgateways/samples/README.md b/packages/google-cloud-beyondcorp-clientgateways/samples/README.md index b61488e1d2c..55a39e1e33a 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/samples/README.md +++ b/packages/google-cloud-beyondcorp-clientgateways/samples/README.md @@ -17,7 +17,6 @@ * [Client_gateways_service.get_client_gateway](#client_gateways_service.get_client_gateway) * [Client_gateways_service.list_client_gateways](#client_gateways_service.list_client_gateways) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -114,23 +113,6 @@ __Usage:__ `node packages/google-cloud-beyondcorp-clientgateways/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-beyondcorp-clientgateways/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-clientgateways/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-beyondcorp-clientgateways/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientgateways.v1.json b/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientgateways.v1.json index a502f471844..dcc0d22c475 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientgateways.v1.json +++ b/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata.google.cloud.beyondcorp.clientgateways.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-clientgateways", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientgateways.v1.json b/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientgateways.v1.json new file mode 100644 index 00000000000..dcc0d22c475 --- /dev/null +++ b/packages/google-cloud-beyondcorp-clientgateways/samples/generated/v1/snippet_metadata_google.cloud.beyondcorp.clientgateways.v1.json @@ -0,0 +1,215 @@ +{ + "clientLibrary": { + "name": "nodejs-clientgateways", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.beyondcorp.clientgateways.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "beyondcorp_v1_generated_ClientGatewaysService_ListClientGateways_async", + "title": "ClientGatewaysService listClientGateways Sample", + "origin": "API_DEFINITION", + "description": " Lists ClientGateways in a given project and location.", + "canonical": true, + "file": "client_gateways_service.list_client_gateways.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListClientGateways", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.ListClientGateways", + "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.clientgateways.v1.ListClientGatewaysResponse", + "client": { + "shortName": "ClientGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysServiceClient" + }, + "method": { + "shortName": "ListClientGateways", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.ListClientGateways", + "service": { + "shortName": "ClientGatewaysService", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientGatewaysService_GetClientGateway_async", + "title": "ClientGatewaysService getClientGateway Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single ClientGateway.", + "canonical": true, + "file": "client_gateways_service.get_client_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.GetClientGateway", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.beyondcorp.clientgateways.v1.ClientGateway", + "client": { + "shortName": "ClientGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysServiceClient" + }, + "method": { + "shortName": "GetClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.GetClientGateway", + "service": { + "shortName": "ClientGatewaysService", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientGatewaysService_CreateClientGateway_async", + "title": "ClientGatewaysService createClientGateway Sample", + "origin": "API_DEFINITION", + "description": " Creates a new ClientGateway in a given project and location.", + "canonical": true, + "file": "client_gateways_service.create_client_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.CreateClientGateway", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "client_gateway_id", + "type": "TYPE_STRING" + }, + { + "name": "client_gateway", + "type": ".google.cloud.beyondcorp.clientgateways.v1.ClientGateway" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ClientGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysServiceClient" + }, + "method": { + "shortName": "CreateClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.CreateClientGateway", + "service": { + "shortName": "ClientGatewaysService", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService" + } + } + } + }, + { + "regionTag": "beyondcorp_v1_generated_ClientGatewaysService_DeleteClientGateway_async", + "title": "ClientGatewaysService deleteClientGateway Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single ClientGateway.", + "canonical": true, + "file": "client_gateways_service.delete_client_gateway.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.DeleteClientGateway", + "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": "ClientGatewaysServiceClient", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysServiceClient" + }, + "method": { + "shortName": "DeleteClientGateway", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService.DeleteClientGateway", + "service": { + "shortName": "ClientGatewaysService", + "fullName": "google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-beyondcorp-clientgateways/samples/package.json b/packages/google-cloud-beyondcorp-clientgateways/samples/package.json index f1ab32dc5d0..d488bb289a6 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/samples/package.json +++ b/packages/google-cloud-beyondcorp-clientgateways/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-clientgateways/src/v1/client_gateways_service_client.ts b/packages/google-cloud-beyondcorp-clientgateways/src/v1/client_gateways_service_client.ts index 2f5f8bba29a..64fc525b1dd 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/src/v1/client_gateways_service_client.ts +++ b/packages/google-cloud-beyondcorp-clientgateways/src/v1/client_gateways_service_client.ts @@ -508,9 +508,8 @@ export class ClientGatewaysServiceClient { * @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.clientgateways.v1.ClientGateway | ClientGateway}. - * 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.clientgateways.v1.ClientGateway|ClientGateway}. + * 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_gateways_service.get_client_gateway.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_GetClientGateway_async @@ -606,7 +605,7 @@ export class ClientGatewaysServiceClient { * @param {string} [request.clientGatewayId] * Optional. User-settable client gateway 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.clientgateways.v1.ClientGateway} request.clientGateway * Required. The resource being created. @@ -633,8 +632,7 @@ export class ClientGatewaysServiceClient { * 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_gateways_service.create_client_gateway.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_CreateClientGateway_async @@ -729,8 +727,7 @@ export class ClientGatewaysServiceClient { * 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_gateways_service.create_client_gateway.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_CreateClientGateway_async @@ -788,8 +785,7 @@ export class ClientGatewaysServiceClient { * 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_gateways_service.delete_client_gateway.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_DeleteClientGateway_async @@ -884,8 +880,7 @@ export class ClientGatewaysServiceClient { * 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_gateways_service.delete_client_gateway.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_DeleteClientGateway_async @@ -932,14 +927,13 @@ export class ClientGatewaysServiceClient { * @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.clientgateways.v1.ClientGateway | ClientGateway}. + * The first element of the array is Array of {@link protos.google.cloud.beyondcorp.clientgateways.v1.ClientGateway|ClientGateway}. * 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 `listClientGatewaysAsync()` * 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. */ listClientGateways( @@ -1035,13 +1029,12 @@ export class ClientGatewaysServiceClient { * @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.clientgateways.v1.ClientGateway | ClientGateway} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.beyondcorp.clientgateways.v1.ClientGateway|ClientGateway} 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 `listClientGatewaysAsync()` * 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. */ listClientGatewaysStream( @@ -1086,12 +1079,11 @@ export class ClientGatewaysServiceClient { * @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.clientgateways.v1.ClientGateway | ClientGateway}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.beyondcorp.clientgateways.v1.ClientGateway|ClientGateway}. 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_gateways_service.list_client_gateways.js * region_tag:beyondcorp_v1_generated_ClientGatewaysService_ListClientGateways_async @@ -1156,7 +1148,7 @@ export class ClientGatewaysServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -1177,8 +1169,7 @@ export class ClientGatewaysServiceClient { * @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. @@ -1204,7 +1195,7 @@ export class ClientGatewaysServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -1225,8 +1216,7 @@ export class ClientGatewaysServiceClient { * @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. @@ -1253,7 +1243,7 @@ export class ClientGatewaysServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -1268,8 +1258,7 @@ export class ClientGatewaysServiceClient { * 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 * ``` @@ -1315,12 +1304,11 @@ export class ClientGatewaysServiceClient { * @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-clientgateways/system-test/install.ts b/packages/google-cloud-beyondcorp-clientgateways/system-test/install.ts index 9c06e9f0bf7..f61fe236476 100644 --- a/packages/google-cloud-beyondcorp-clientgateways/system-test/install.ts +++ b/packages/google-cloud-beyondcorp-clientgateways/system-test/install.ts @@ -1,52 +1,51 @@ -// Not running tests per b/278007126 -// // 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'; -// import {describe, it} from 'mocha'; +import {packNTest} from 'pack-n-play'; +import {readFileSync} from 'fs'; +import {describe, it} from 'mocha'; -// describe('📦 pack-n-play test', () => { -// it('TypeScript code', async function () { -// this.timeout(300000); -// const options = { -// packageDir: process.cwd(), -// sample: { -// description: 'TypeScript user can use the type definitions', -// ts: readFileSync( -// './system-test/fixtures/sample/src/index.ts' -// ).toString(), -// }, -// }; -// await packNTest(options); -// }); +describe('📦 pack-n-play test', () => { + it('TypeScript code', async function () { + this.timeout(300000); + const options = { + packageDir: process.cwd(), + sample: { + description: 'TypeScript user can use the type definitions', + ts: readFileSync( + './system-test/fixtures/sample/src/index.ts' + ).toString(), + }, + }; + await packNTest(options); + }); -// it('JavaScript code', async function () { -// this.timeout(300000); -// const options = { -// packageDir: process.cwd(), -// sample: { -// description: 'JavaScript user can use the library', -// ts: readFileSync( -// './system-test/fixtures/sample/src/index.js' -// ).toString(), -// }, -// }; -// await packNTest(options); -// }); -// }); + it('JavaScript code', async function () { + this.timeout(300000); + const options = { + packageDir: process.cwd(), + sample: { + description: 'JavaScript user can use the library', + ts: readFileSync( + './system-test/fixtures/sample/src/index.js' + ).toString(), + }, + }; + await packNTest(options); + }); +}); diff --git a/packages/google-cloud-bigquery-analyticshub/README.md b/packages/google-cloud-bigquery-analyticshub/README.md index 2222ff79a26..68a687cef28 100644 --- a/packages/google-cloud-bigquery-analyticshub/README.md +++ b/packages/google-cloud-bigquery-analyticshub/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Analytics Hub API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Analytics Hub API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-bigquery-analyticshub) [![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/bigquery-analyticshub.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-analyticshub) @@ -107,27 +107,26 @@ callListListings(); ## 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-bigquery-analyticshub/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Analytics_hub_service.create_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_data_exchange.js,samples/README.md) | -| Analytics_hub_service.create_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_listing.js,samples/README.md) | -| Analytics_hub_service.delete_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_data_exchange.js,samples/README.md) | -| Analytics_hub_service.delete_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_listing.js,samples/README.md) | -| Analytics_hub_service.get_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_data_exchange.js,samples/README.md) | -| Analytics_hub_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_iam_policy.js,samples/README.md) | -| Analytics_hub_service.get_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_listing.js,samples/README.md) | -| Analytics_hub_service.list_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_data_exchanges.js,samples/README.md) | -| Analytics_hub_service.list_listings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_listings.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_listings.js,samples/README.md) | -| Analytics_hub_service.list_org_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_org_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_org_data_exchanges.js,samples/README.md) | -| Analytics_hub_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.set_iam_policy.js,samples/README.md) | -| Analytics_hub_service.subscribe_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.subscribe_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.subscribe_listing.js,samples/README.md) | -| Analytics_hub_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js,samples/README.md) | -| Analytics_hub_service.update_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_data_exchange.js,samples/README.md) | -| Analytics_hub_service.update_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_listing.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/samples/test/quickstart.js,samples/README.md) | +| Analytics_hub_service.create_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_data_exchange.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.create_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.create_listing.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.delete_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_data_exchange.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.delete_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.delete_listing.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.get_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_data_exchange.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_iam_policy.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.get_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.get_listing.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.list_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_data_exchanges.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.list_listings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_listings.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_listings.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.list_org_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_org_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.list_org_data_exchanges.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.set_iam_policy.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.subscribe_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.subscribe_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.subscribe_listing.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.update_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_data_exchange.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Analytics_hub_service.update_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.update_listing.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/samples/quickstart.js,packages/google-cloud-bigquery-analyticshub/samples/README.md) | diff --git a/packages/google-cloud-bigquery-analyticshub/package.json b/packages/google-cloud-bigquery-analyticshub/package.json index 7ca20005e71..e35b5f230d8 100644 --- a/packages/google-cloud-bigquery-analyticshub/package.json +++ b/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/samples/README.md b/packages/google-cloud-bigquery-analyticshub/samples/README.md index 4c07eb85824..6cb30d283aa 100644 --- a/packages/google-cloud-bigquery-analyticshub/samples/README.md +++ b/packages/google-cloud-bigquery-analyticshub/samples/README.md @@ -28,7 +28,6 @@ * [Analytics_hub_service.update_data_exchange](#analytics_hub_service.update_data_exchange) * [Analytics_hub_service.update_listing](#analytics_hub_service.update_listing) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -312,23 +311,6 @@ __Usage:__ `node packages/google-cloud-bigquery-analyticshub/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-bigquery-analyticshub/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js index 3bc9d267508..81b0d2a177b 100644 --- a/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/analytics_hub_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Analyticshub library const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-analyticshub').v1; diff --git a/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata.google.cloud.bigquery.analyticshub.v1.json b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata.google.cloud.bigquery.analyticshub.v1.json index dc3d09f44d5..f51e22dfae2 100644 --- a/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata.google.cloud.bigquery.analyticshub.v1.json +++ b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata.google.cloud.bigquery.analyticshub.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-analyticshub", - "version": "0.2.1", + "version": "0.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata_google.cloud.bigquery.analyticshub.v1.json b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata_google.cloud.bigquery.analyticshub.v1.json new file mode 100644 index 00000000000..f51e22dfae2 --- /dev/null +++ b/packages/google-cloud-bigquery-analyticshub/samples/generated/v1/snippet_metadata_google.cloud.bigquery.analyticshub.v1.json @@ -0,0 +1,683 @@ +{ + "clientLibrary": { + "name": "nodejs-analyticshub", + "version": "0.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.analyticshub.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_ListDataExchanges_async", + "title": "AnalyticsHubService listDataExchanges Sample", + "origin": "API_DEFINITION", + "description": " Lists all data exchanges in a given project and location.", + "canonical": true, + "file": "analytics_hub_service.list_data_exchanges.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataExchanges", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListDataExchanges", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.ListDataExchangesResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListDataExchanges", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListDataExchanges", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_ListOrgDataExchanges_async", + "title": "AnalyticsHubService listOrgDataExchanges Sample", + "origin": "API_DEFINITION", + "description": " Lists all data exchanges from projects in a given organization and location.", + "canonical": true, + "file": "analytics_hub_service.list_org_data_exchanges.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOrgDataExchanges", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListOrgDataExchanges", + "async": true, + "parameters": [ + { + "name": "organization", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListOrgDataExchanges", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListOrgDataExchanges", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_GetDataExchange_async", + "title": "AnalyticsHubService getDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of a data exchange.", + "canonical": true, + "file": "analytics_hub_service.get_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetDataExchange", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_CreateDataExchange_async", + "title": "AnalyticsHubService createDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Creates a new data exchange.", + "canonical": true, + "file": "analytics_hub_service.create_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.CreateDataExchange", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_exchange_id", + "type": "TYPE_STRING" + }, + { + "name": "data_exchange", + "type": ".google.cloud.bigquery.analyticshub.v1.DataExchange" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "CreateDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.CreateDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_UpdateDataExchange_async", + "title": "AnalyticsHubService updateDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing data exchange.", + "canonical": true, + "file": "analytics_hub_service.update_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.UpdateDataExchange", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "data_exchange", + "type": ".google.cloud.bigquery.analyticshub.v1.DataExchange" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "UpdateDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.UpdateDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_DeleteDataExchange_async", + "title": "AnalyticsHubService deleteDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Deletes an existing data exchange.", + "canonical": true, + "file": "analytics_hub_service.delete_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.DeleteDataExchange", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "DeleteDataExchange", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.DeleteDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_ListListings_async", + "title": "AnalyticsHubService listListings Sample", + "origin": "API_DEFINITION", + "description": " Lists all listings in a given project and location.", + "canonical": true, + "file": "analytics_hub_service.list_listings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListListings", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListListings", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.ListListingsResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListListings", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.ListListings", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_GetListing_async", + "title": "AnalyticsHubService getListing Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of a listing.", + "canonical": true, + "file": "analytics_hub_service.get_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetListing", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_CreateListing_async", + "title": "AnalyticsHubService createListing Sample", + "origin": "API_DEFINITION", + "description": " Creates a new listing.", + "canonical": true, + "file": "analytics_hub_service.create_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.CreateListing", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "listing_id", + "type": "TYPE_STRING" + }, + { + "name": "listing", + "type": ".google.cloud.bigquery.analyticshub.v1.Listing" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "CreateListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.CreateListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_UpdateListing_async", + "title": "AnalyticsHubService updateListing Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing listing.", + "canonical": true, + "file": "analytics_hub_service.update_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.UpdateListing", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "listing", + "type": ".google.cloud.bigquery.analyticshub.v1.Listing" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "UpdateListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.UpdateListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_DeleteListing_async", + "title": "AnalyticsHubService deleteListing Sample", + "origin": "API_DEFINITION", + "description": " Deletes a listing.", + "canonical": true, + "file": "analytics_hub_service.delete_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.DeleteListing", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "DeleteListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.DeleteListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_SubscribeListing_async", + "title": "AnalyticsHubService subscribeListing Sample", + "origin": "API_DEFINITION", + "description": " Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.", + "canonical": true, + "file": "analytics_hub_service.subscribe_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SubscribeListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.SubscribeListing", + "async": true, + "parameters": [ + { + "name": "destination_dataset", + "type": ".google.cloud.bigquery.analyticshub.v1.DestinationDataset" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.analyticshub.v1.SubscribeListingResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "SubscribeListing", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.SubscribeListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_GetIamPolicy_async", + "title": "AnalyticsHubService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy.", + "canonical": true, + "file": "analytics_hub_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.GetIamPolicy", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_SetIamPolicy_async", + "title": "AnalyticsHubService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy.", + "canonical": true, + "file": "analytics_hub_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.SetIamPolicy", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1_generated_AnalyticsHubService_TestIamPermissions_async", + "title": "AnalyticsHubService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the permissions that a caller has.", + "canonical": true, + "file": "analytics_hub_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService.TestIamPermissions", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.analyticshub.v1.AnalyticsHubService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-analyticshub/samples/package.json b/packages/google-cloud-bigquery-analyticshub/samples/package.json index b57024e03b5..a54b1b23b46 100644 --- a/packages/google-cloud-bigquery-analyticshub/samples/package.json +++ b/packages/google-cloud-bigquery-analyticshub/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-bigquery-analyticshub/src/v1/analytics_hub_service_client.ts b/packages/google-cloud-bigquery-analyticshub/src/v1/analytics_hub_service_client.ts index 7cc692f76d5..66a5791e9d8 100644 --- a/packages/google-cloud-bigquery-analyticshub/src/v1/analytics_hub_service_client.ts +++ b/packages/google-cloud-bigquery-analyticshub/src/v1/analytics_hub_service_client.ts @@ -375,9 +375,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. - * 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.bigquery.analyticshub.v1.DataExchange|DataExchange}. + * 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/analytics_hub_service.get_data_exchange.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_GetDataExchange_async @@ -481,9 +480,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. - * 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.bigquery.analyticshub.v1.DataExchange|DataExchange}. + * 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/analytics_hub_service.create_data_exchange.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_CreateDataExchange_async @@ -582,9 +580,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. - * 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.bigquery.analyticshub.v1.DataExchange|DataExchange}. + * 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/analytics_hub_service.update_data_exchange.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_UpdateDataExchange_async @@ -680,9 +677,8 @@ export class AnalyticsHubServiceClient { * @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/analytics_hub_service.delete_data_exchange.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_DeleteDataExchange_async @@ -778,9 +774,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing}. - * 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.bigquery.analyticshub.v1.Listing|Listing}. + * 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/analytics_hub_service.get_listing.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_GetListing_async @@ -884,9 +879,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing}. - * 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.bigquery.analyticshub.v1.Listing|Listing}. + * 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/analytics_hub_service.create_listing.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_CreateListing_async @@ -985,9 +979,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing}. - * 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.bigquery.analyticshub.v1.Listing|Listing}. + * 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/analytics_hub_service.update_listing.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_UpdateListing_async @@ -1083,9 +1076,8 @@ export class AnalyticsHubServiceClient { * @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/analytics_hub_service.delete_listing.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_DeleteListing_async @@ -1188,9 +1180,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.SubscribeListingResponse | SubscribeListingResponse}. - * 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.bigquery.analyticshub.v1.SubscribeListingResponse|SubscribeListingResponse}. + * 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/analytics_hub_service.subscribe_listing.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_SubscribeListing_async @@ -1289,9 +1280,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/analytics_hub_service.get_iam_policy.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_GetIamPolicy_async @@ -1384,9 +1374,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/analytics_hub_service.set_iam_policy.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_SetIamPolicy_async @@ -1473,9 +1462,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/analytics_hub_service.test_iam_permissions.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_TestIamPermissions_async @@ -1564,14 +1552,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange}. * 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 `listDataExchangesAsync()` * 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. */ listDataExchanges( @@ -1665,13 +1652,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange} 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 `listDataExchangesAsync()` * 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. */ listDataExchangesStream( @@ -1714,12 +1700,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange}. 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/analytics_hub_service.list_data_exchanges.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_ListDataExchanges_async @@ -1763,14 +1748,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange}. * 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 `listOrgDataExchangesAsync()` * 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. */ listOrgDataExchanges( @@ -1864,13 +1848,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange} 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 `listOrgDataExchangesAsync()` * 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. */ listOrgDataExchangesStream( @@ -1913,12 +1896,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.DataExchange | DataExchange}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.analyticshub.v1.DataExchange|DataExchange}. 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/analytics_hub_service.list_org_data_exchanges.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_ListOrgDataExchanges_async @@ -1961,14 +1943,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.analyticshub.v1.Listing|Listing}. * 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 `listListingsAsync()` * 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. */ listListings( @@ -2062,13 +2043,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.analyticshub.v1.Listing|Listing} 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 `listListingsAsync()` * 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. */ listListingsStream( @@ -2111,12 +2091,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.analyticshub.v1.Listing | Listing}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.analyticshub.v1.Listing|Listing}. 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/analytics_hub_service.list_listings.js * region_tag:analyticshub_v1_generated_AnalyticsHubService_ListListings_async diff --git a/packages/google-cloud-bigquery-connection/package.json b/packages/google-cloud-bigquery-connection/package.json index 2bcfe183969..5a627997a88 100644 --- a/packages/google-cloud-bigquery-connection/package.json +++ b/packages/google-cloud-bigquery-connection/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-cloud-bigquery-connection" } diff --git a/packages/google-cloud-bigquery-connection/samples/generated/v1/connection_service.test_iam_permissions.js b/packages/google-cloud-bigquery-connection/samples/generated/v1/connection_service.test_iam_permissions.js index 124bab1289d..ed5f0ac4382 100644 --- a/packages/google-cloud-bigquery-connection/samples/generated/v1/connection_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-connection/samples/generated/v1/connection_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Connection library const {ConnectionServiceClient} = require('@google-cloud/bigquery-connection').v1; diff --git a/packages/google-cloud-bigquery-connection/samples/generated/v1/snippet_metadata_google.cloud.bigquery.connection.v1.json b/packages/google-cloud-bigquery-connection/samples/generated/v1/snippet_metadata_google.cloud.bigquery.connection.v1.json new file mode 100644 index 00000000000..f6c2b74511e --- /dev/null +++ b/packages/google-cloud-bigquery-connection/samples/generated/v1/snippet_metadata_google.cloud.bigquery.connection.v1.json @@ -0,0 +1,375 @@ +{ + "clientLibrary": { + "name": "nodejs-connection", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.connection.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_CreateConnection_async", + "title": "ConnectionService createConnection Sample", + "origin": "API_DEFINITION", + "description": " Creates a new connection.", + "canonical": true, + "file": "connection_service.create_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.CreateConnection", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "connection_id", + "type": "TYPE_STRING" + }, + { + "name": "connection", + "type": ".google.cloud.bigquery.connection.v1.Connection" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "CreateConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.CreateConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_GetConnection_async", + "title": "ConnectionService getConnection Sample", + "origin": "API_DEFINITION", + "description": " Returns specified connection.", + "canonical": true, + "file": "connection_service.get_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.GetConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "GetConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.GetConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_ListConnections_async", + "title": "ConnectionService listConnections Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of connections in the given project.", + "canonical": true, + "file": "connection_service.list_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConnections", + "fullName": "google.cloud.bigquery.connection.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.bigquery.connection.v1.ListConnectionsResponse", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "ListConnections", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.ListConnections", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_UpdateConnection_async", + "title": "ConnectionService updateConnection Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.", + "canonical": true, + "file": "connection_service.update_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.UpdateConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "connection", + "type": ".google.cloud.bigquery.connection.v1.Connection" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "UpdateConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.UpdateConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_DeleteConnection_async", + "title": "ConnectionService deleteConnection Sample", + "origin": "API_DEFINITION", + "description": " Deletes connection and associated credential.", + "canonical": true, + "file": "connection_service.delete_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.DeleteConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "DeleteConnection", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.DeleteConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_GetIamPolicy_async", + "title": "ConnectionService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "canonical": true, + "file": "connection_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.GetIamPolicy", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_SetIamPolicy_async", + "title": "ConnectionService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "canonical": true, + "file": "connection_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.SetIamPolicy", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1_generated_ConnectionService_TestIamPermissions_async", + "title": "ConnectionService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "canonical": true, + "file": "connection_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService.TestIamPermissions", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1.ConnectionService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/connection_service.test_iam_permissions.js b/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/connection_service.test_iam_permissions.js index f6f72d4be58..65967b0289c 100644 --- a/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/connection_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/connection_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Connection library const {ConnectionServiceClient} = require('connection').v1beta1; diff --git a/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.connection.v1beta1.json b/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.connection.v1beta1.json new file mode 100644 index 00000000000..41458050465 --- /dev/null +++ b/packages/google-cloud-bigquery-connection/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.connection.v1beta1.json @@ -0,0 +1,419 @@ +{ + "clientLibrary": { + "name": "nodejs-connection", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.connection.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_CreateConnection_async", + "title": "ConnectionService createConnection Sample", + "origin": "API_DEFINITION", + "description": " Creates a new connection.", + "canonical": true, + "file": "connection_service.create_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnection", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "connection_id", + "type": "TYPE_STRING" + }, + { + "name": "connection", + "type": ".google.cloud.bigquery.connection.v1beta1.Connection" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1beta1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "CreateConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_GetConnection_async", + "title": "ConnectionService getConnection Sample", + "origin": "API_DEFINITION", + "description": " Returns specified connection.", + "canonical": true, + "file": "connection_service.get_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1beta1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "GetConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_ListConnections_async", + "title": "ConnectionService listConnections Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of connections in the given project.", + "canonical": true, + "file": "connection_service.list_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConnections", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "max_results", + "type": ".google.protobuf.UInt32Value" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "ListConnections", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnections", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_UpdateConnection_async", + "title": "ConnectionService updateConnection Sample", + "origin": "API_DEFINITION", + "description": " Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.", + "canonical": true, + "file": "connection_service.update_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "connection", + "type": ".google.cloud.bigquery.connection.v1beta1.Connection" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.connection.v1beta1.Connection", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "UpdateConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_UpdateConnectionCredential_async", + "title": "ConnectionService updateConnectionCredential Sample", + "origin": "API_DEFINITION", + "description": " Sets the credential for the specified connection.", + "canonical": true, + "file": "connection_service.update_connection_credential.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConnectionCredential", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredential", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "credential", + "type": ".google.cloud.bigquery.connection.v1beta1.ConnectionCredential" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "UpdateConnectionCredential", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredential", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_DeleteConnection_async", + "title": "ConnectionService deleteConnection Sample", + "origin": "API_DEFINITION", + "description": " Deletes connection and associated credential.", + "canonical": true, + "file": "connection_service.delete_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.DeleteConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "DeleteConnection", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.DeleteConnection", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_GetIamPolicy_async", + "title": "ConnectionService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "canonical": true, + "file": "connection_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.GetIamPolicy", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_SetIamPolicy_async", + "title": "ConnectionService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "canonical": true, + "file": "connection_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.SetIamPolicy", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + }, + { + "regionTag": "bigqueryconnection_v1beta1_generated_ConnectionService_TestIamPermissions_async", + "title": "ConnectionService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "canonical": true, + "file": "connection_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "ConnectionServiceClient", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService.TestIamPermissions", + "service": { + "shortName": "ConnectionService", + "fullName": "google.cloud.bigquery.connection.v1beta1.ConnectionService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-connection/samples/package.json b/packages/google-cloud-bigquery-connection/samples/package.json index 25e8814ac03..52132c15018 100644 --- a/packages/google-cloud-bigquery-connection/samples/package.json +++ b/packages/google-cloud-bigquery-connection/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-bigquery-connection/src/v1/connection_service_client.ts b/packages/google-cloud-bigquery-connection/src/v1/connection_service_client.ts index bf16926fc23..b4338d7a2a5 100644 --- a/packages/google-cloud-bigquery-connection/src/v1/connection_service_client.ts +++ b/packages/google-cloud-bigquery-connection/src/v1/connection_service_client.ts @@ -363,9 +363,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1.Connection | Connection}. - * 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.bigquery.connection.v1.Connection|Connection}. + * 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/connection_service.create_connection.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_CreateConnection_async @@ -461,9 +460,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1.Connection | Connection}. - * 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.bigquery.connection.v1.Connection|Connection}. + * 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/connection_service.get_connection.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_GetConnection_async @@ -564,9 +562,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1.Connection | Connection}. - * 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.bigquery.connection.v1.Connection|Connection}. + * 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/connection_service.update_connection.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_UpdateConnection_async @@ -662,9 +659,8 @@ 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 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/connection_service.delete_connection.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_DeleteConnection_async @@ -765,9 +761,8 @@ 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 an object representing {@link google.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/connection_service.get_iam_policy.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_GetIamPolicy_async @@ -863,9 +858,8 @@ 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 an object representing {@link google.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/connection_service.set_iam_policy.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_SetIamPolicy_async @@ -958,9 +952,8 @@ 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 an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/connection_service.test_iam_permissions.js * region_tag:bigqueryconnection_v1_generated_ConnectionService_TestIamPermissions_async @@ -1047,14 +1040,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.bigquery.connection.v1.Connection | Connection}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.connection.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( @@ -1146,13 +1138,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.bigquery.connection.v1.Connection | Connection} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.connection.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( @@ -1193,12 +1184,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.bigquery.connection.v1.Connection | Connection}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.connection.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:bigqueryconnection_v1_generated_ConnectionService_ListConnections_async diff --git a/packages/google-cloud-bigquery-connection/src/v1beta1/connection_service_client.ts b/packages/google-cloud-bigquery-connection/src/v1beta1/connection_service_client.ts index fef8bfd1d94..2b588b98776 100644 --- a/packages/google-cloud-bigquery-connection/src/v1beta1/connection_service_client.ts +++ b/packages/google-cloud-bigquery-connection/src/v1beta1/connection_service_client.ts @@ -345,9 +345,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1beta1.Connection | Connection}. - * 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.bigquery.connection.v1beta1.Connection|Connection}. + * 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/connection_service.create_connection.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_CreateConnection_async @@ -443,9 +442,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1beta1.Connection | Connection}. - * 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.bigquery.connection.v1beta1.Connection|Connection}. + * 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/connection_service.get_connection.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_GetConnection_async @@ -545,9 +543,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse | ListConnectionsResponse}. - * 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.bigquery.connection.v1beta1.ListConnectionsResponse|ListConnectionsResponse}. + * 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/connection_service.list_connections.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_ListConnections_async @@ -648,9 +645,8 @@ 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 an object representing {@link google.cloud.bigquery.connection.v1beta1.Connection | Connection}. - * 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.bigquery.connection.v1beta1.Connection|Connection}. + * 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/connection_service.update_connection.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_UpdateConnection_async @@ -748,9 +744,8 @@ 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 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/connection_service.update_connection_credential.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_UpdateConnectionCredential_async @@ -850,9 +845,8 @@ 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 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/connection_service.delete_connection.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_DeleteConnection_async @@ -953,9 +947,8 @@ 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 an object representing {@link google.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/connection_service.get_iam_policy.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_GetIamPolicy_async @@ -1051,9 +1044,8 @@ 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 an object representing {@link google.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/connection_service.set_iam_policy.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_SetIamPolicy_async @@ -1146,9 +1138,8 @@ 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 an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/connection_service.test_iam_permissions.js * region_tag:bigqueryconnection_v1beta1_generated_ConnectionService_TestIamPermissions_async diff --git a/packages/google-cloud-bigquery-dataexchange/README.md b/packages/google-cloud-bigquery-dataexchange/README.md index 1739bc80543..354b6b03e7f 100644 --- a/packages/google-cloud-bigquery-dataexchange/README.md +++ b/packages/google-cloud-bigquery-dataexchange/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Analytics Hub API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Analytics Hub API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-bigquery-dataexchange) [![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/bigquery-data-exchange.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-data-exchange) @@ -104,27 +104,26 @@ callListDataExchanges(); ## 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-bigquery-dataexchange/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Analytics_hub_service.create_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_data_exchange.js,samples/README.md) | -| Analytics_hub_service.create_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_listing.js,samples/README.md) | -| Analytics_hub_service.delete_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_data_exchange.js,samples/README.md) | -| Analytics_hub_service.delete_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_listing.js,samples/README.md) | -| Analytics_hub_service.get_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_data_exchange.js,samples/README.md) | -| Analytics_hub_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_iam_policy.js,samples/README.md) | -| Analytics_hub_service.get_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_listing.js,samples/README.md) | -| Analytics_hub_service.list_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_data_exchanges.js,samples/README.md) | -| Analytics_hub_service.list_listings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_listings.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_listings.js,samples/README.md) | -| Analytics_hub_service.list_org_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_org_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_org_data_exchanges.js,samples/README.md) | -| Analytics_hub_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.set_iam_policy.js,samples/README.md) | -| Analytics_hub_service.subscribe_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.subscribe_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.subscribe_listing.js,samples/README.md) | -| Analytics_hub_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js,samples/README.md) | -| Analytics_hub_service.update_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_data_exchange.js,samples/README.md) | -| Analytics_hub_service.update_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_listing.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/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-bigquery-dataexchange/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/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-bigquery-dataexchange/samples/test/quickstart.js,samples/README.md) | +| Analytics_hub_service.create_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_data_exchange.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.create_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.create_listing.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.delete_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_data_exchange.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.delete_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.delete_listing.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.get_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_data_exchange.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_iam_policy.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.get_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.get_listing.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.list_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_data_exchanges.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.list_listings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_listings.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_listings.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.list_org_data_exchanges | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_org_data_exchanges.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.list_org_data_exchanges.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.set_iam_policy.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.subscribe_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.subscribe_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.subscribe_listing.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.update_data_exchange | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_data_exchange.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_data_exchange.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Analytics_hub_service.update_listing | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_listing.js) | [![Open in Cloud Shell][shell_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-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.update_listing.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/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-bigquery-dataexchange/samples/quickstart.js,packages/google-cloud-bigquery-dataexchange/samples/README.md) | diff --git a/packages/google-cloud-bigquery-dataexchange/package.json b/packages/google-cloud-bigquery-dataexchange/package.json index 2a54f118816..b66c4f6b8fd 100644 --- a/packages/google-cloud-bigquery-dataexchange/package.json +++ b/packages/google-cloud-bigquery-dataexchange/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": "^10.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", @@ -64,11 +65,11 @@ "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" } } diff --git a/packages/google-cloud-bigquery-dataexchange/samples/README.md b/packages/google-cloud-bigquery-dataexchange/samples/README.md index bbb673db139..e0eecd1f9ca 100644 --- a/packages/google-cloud-bigquery-dataexchange/samples/README.md +++ b/packages/google-cloud-bigquery-dataexchange/samples/README.md @@ -28,7 +28,6 @@ * [Analytics_hub_service.update_data_exchange](#analytics_hub_service.update_data_exchange) * [Analytics_hub_service.update_listing](#analytics_hub_service.update_listing) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -312,23 +311,6 @@ __Usage:__ `node packages/google-cloud-bigquery-dataexchange/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-dataexchange/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-bigquery-dataexchange/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-bigquery-dataexchange/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js index 92f3e9ca2c3..b4b47b46bfb 100644 --- a/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/analytics_hub_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Dataexchange library const {AnalyticsHubServiceClient} = require('@google-cloud/bigquery-data-exchange').v1beta1; diff --git a/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.dataexchange.v1beta1.json b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.dataexchange.v1beta1.json index 1eaea9aae20..a8ae0dd3b98 100644 --- a/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.dataexchange.v1beta1.json +++ b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.dataexchange.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-dataexchange", - "version": "0.4.1", + "version": "0.4.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json new file mode 100644 index 00000000000..a8ae0dd3b98 --- /dev/null +++ b/packages/google-cloud-bigquery-dataexchange/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.dataexchange.v1beta1.json @@ -0,0 +1,683 @@ +{ + "clientLibrary": { + "name": "nodejs-dataexchange", + "version": "0.4.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.dataexchange.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_ListDataExchanges_async", + "title": "AnalyticsHubService listDataExchanges Sample", + "origin": "API_DEFINITION", + "description": " Lists all data exchanges in a given project and location.", + "canonical": true, + "file": "analytics_hub_service.list_data_exchanges.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataExchanges", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListDataExchanges", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListDataExchanges", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListDataExchanges", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_ListOrgDataExchanges_async", + "title": "AnalyticsHubService listOrgDataExchanges Sample", + "origin": "API_DEFINITION", + "description": " Lists all data exchanges from projects in a given organization and location.", + "canonical": true, + "file": "analytics_hub_service.list_org_data_exchanges.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOrgDataExchanges", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListOrgDataExchanges", + "async": true, + "parameters": [ + { + "name": "organization", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListOrgDataExchanges", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListOrgDataExchanges", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_GetDataExchange_async", + "title": "AnalyticsHubService getDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of a data exchange.", + "canonical": true, + "file": "analytics_hub_service.get_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetDataExchange", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_CreateDataExchange_async", + "title": "AnalyticsHubService createDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Creates a new data exchange.", + "canonical": true, + "file": "analytics_hub_service.create_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateDataExchange", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_exchange_id", + "type": "TYPE_STRING" + }, + { + "name": "data_exchange", + "type": ".google.cloud.bigquery.dataexchange.v1beta1.DataExchange" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "CreateDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_UpdateDataExchange_async", + "title": "AnalyticsHubService updateDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing data exchange.", + "canonical": true, + "file": "analytics_hub_service.update_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateDataExchange", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "data_exchange", + "type": ".google.cloud.bigquery.dataexchange.v1beta1.DataExchange" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.DataExchange", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "UpdateDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_DeleteDataExchange_async", + "title": "AnalyticsHubService deleteDataExchange Sample", + "origin": "API_DEFINITION", + "description": " Deletes an existing data exchange.", + "canonical": true, + "file": "analytics_hub_service.delete_data_exchange.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteDataExchange", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "DeleteDataExchange", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteDataExchange", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_ListListings_async", + "title": "AnalyticsHubService listListings Sample", + "origin": "API_DEFINITION", + "description": " Lists all listings in a given project and location.", + "canonical": true, + "file": "analytics_hub_service.list_listings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListListings", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListListings", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "ListListings", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListListings", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_GetListing_async", + "title": "AnalyticsHubService getListing Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of a listing.", + "canonical": true, + "file": "analytics_hub_service.get_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetListing", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_CreateListing_async", + "title": "AnalyticsHubService createListing Sample", + "origin": "API_DEFINITION", + "description": " Creates a new listing.", + "canonical": true, + "file": "analytics_hub_service.create_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateListing", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "listing_id", + "type": "TYPE_STRING" + }, + { + "name": "listing", + "type": ".google.cloud.bigquery.dataexchange.v1beta1.Listing" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "CreateListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_UpdateListing_async", + "title": "AnalyticsHubService updateListing Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing listing.", + "canonical": true, + "file": "analytics_hub_service.update_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateListing", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "listing", + "type": ".google.cloud.bigquery.dataexchange.v1beta1.Listing" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.Listing", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "UpdateListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_DeleteListing_async", + "title": "AnalyticsHubService deleteListing Sample", + "origin": "API_DEFINITION", + "description": " Deletes a listing.", + "canonical": true, + "file": "analytics_hub_service.delete_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteListing", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "DeleteListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_SubscribeListing_async", + "title": "AnalyticsHubService subscribeListing Sample", + "origin": "API_DEFINITION", + "description": " Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.", + "canonical": true, + "file": "analytics_hub_service.subscribe_listing.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SubscribeListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SubscribeListing", + "async": true, + "parameters": [ + { + "name": "destination_dataset", + "type": ".google.cloud.bigquery.dataexchange.v1beta1.DestinationDataset" + }, + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "SubscribeListing", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SubscribeListing", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_GetIamPolicy_async", + "title": "AnalyticsHubService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy.", + "canonical": true, + "file": "analytics_hub_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetIamPolicy", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_SetIamPolicy_async", + "title": "AnalyticsHubService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy.", + "canonical": true, + "file": "analytics_hub_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SetIamPolicy", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + }, + { + "regionTag": "analyticshub_v1beta1_generated_AnalyticsHubService_TestIamPermissions_async", + "title": "AnalyticsHubService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the permissions that a caller has.", + "canonical": true, + "file": "analytics_hub_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "AnalyticsHubServiceClient", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.TestIamPermissions", + "service": { + "shortName": "AnalyticsHubService", + "fullName": "google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-dataexchange/samples/package.json b/packages/google-cloud-bigquery-dataexchange/samples/package.json index fc0d065b0d5..614cc05a668 100644 --- a/packages/google-cloud-bigquery-dataexchange/samples/package.json +++ b/packages/google-cloud-bigquery-dataexchange/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12" + "node": ">=14.0.0" }, "files": [ "*.js" @@ -20,4 +20,4 @@ "chai": "^4.2.0", "mocha": "^10.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-dataexchange/src/v1beta1/analytics_hub_service_client.ts b/packages/google-cloud-bigquery-dataexchange/src/v1beta1/analytics_hub_service_client.ts index e0bd93d6a3f..4580ab2a558 100644 --- a/packages/google-cloud-bigquery-dataexchange/src/v1beta1/analytics_hub_service_client.ts +++ b/packages/google-cloud-bigquery-dataexchange/src/v1beta1/analytics_hub_service_client.ts @@ -382,9 +382,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. - * 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.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. + * 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/analytics_hub_service.get_data_exchange.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_GetDataExchange_async @@ -488,9 +487,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. - * 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.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. + * 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/analytics_hub_service.create_data_exchange.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_CreateDataExchange_async @@ -589,9 +587,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. - * 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.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. + * 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/analytics_hub_service.update_data_exchange.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_UpdateDataExchange_async @@ -687,9 +684,8 @@ export class AnalyticsHubServiceClient { * @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/analytics_hub_service.delete_data_exchange.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_DeleteDataExchange_async @@ -785,9 +781,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing}. - * 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.bigquery.dataexchange.v1beta1.Listing|Listing}. + * 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/analytics_hub_service.get_listing.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_GetListing_async @@ -891,9 +886,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing}. - * 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.bigquery.dataexchange.v1beta1.Listing|Listing}. + * 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/analytics_hub_service.create_listing.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_CreateListing_async @@ -992,9 +986,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing}. - * 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.bigquery.dataexchange.v1beta1.Listing|Listing}. + * 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/analytics_hub_service.update_listing.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_UpdateListing_async @@ -1090,9 +1083,8 @@ export class AnalyticsHubServiceClient { * @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/analytics_hub_service.delete_listing.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_DeleteListing_async @@ -1195,9 +1187,8 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.SubscribeListingResponse | SubscribeListingResponse}. - * 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.bigquery.dataexchange.v1beta1.SubscribeListingResponse|SubscribeListingResponse}. + * 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/analytics_hub_service.subscribe_listing.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_SubscribeListing_async @@ -1296,9 +1287,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/analytics_hub_service.get_iam_policy.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_GetIamPolicy_async @@ -1391,9 +1381,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/analytics_hub_service.set_iam_policy.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_SetIamPolicy_async @@ -1480,9 +1469,8 @@ export class AnalyticsHubServiceClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/analytics_hub_service.test_iam_permissions.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_TestIamPermissions_async @@ -1571,14 +1559,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. * 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 `listDataExchangesAsync()` * 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. */ listDataExchanges( @@ -1672,13 +1659,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange} 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 `listDataExchangesAsync()` * 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. */ listDataExchangesStream( @@ -1721,12 +1707,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. 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/analytics_hub_service.list_data_exchanges.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_ListDataExchanges_async @@ -1770,14 +1755,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. * 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 `listOrgDataExchangesAsync()` * 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. */ listOrgDataExchanges( @@ -1871,13 +1855,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange} 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 `listOrgDataExchangesAsync()` * 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. */ listOrgDataExchangesStream( @@ -1920,12 +1903,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.DataExchange | DataExchange}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.dataexchange.v1beta1.DataExchange|DataExchange}. 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/analytics_hub_service.list_org_data_exchanges.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_ListOrgDataExchanges_async @@ -1968,14 +1950,13 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.dataexchange.v1beta1.Listing|Listing}. * 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 `listListingsAsync()` * 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. */ listListings( @@ -2069,13 +2050,12 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.dataexchange.v1beta1.Listing|Listing} 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 `listListingsAsync()` * 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. */ listListingsStream( @@ -2118,12 +2098,11 @@ export class AnalyticsHubServiceClient { * @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.bigquery.dataexchange.v1beta1.Listing | Listing}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.dataexchange.v1beta1.Listing|Listing}. 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/analytics_hub_service.list_listings.js * region_tag:analyticshub_v1beta1_generated_AnalyticsHubService_ListListings_async @@ -2160,8 +2139,7 @@ export class AnalyticsHubServiceClient { * 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 * ``` @@ -2207,12 +2185,11 @@ export class AnalyticsHubServiceClient { * @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-bigquery-datapolicies/README.md b/packages/google-cloud-bigquery-datapolicies/README.md index eaa2d006e59..d4802d10c8e 100644 --- a/packages/google-cloud-bigquery-datapolicies/README.md +++ b/packages/google-cloud-bigquery-datapolicies/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-bigquery-datapolicies) [![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/bigquery-datapolicies.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-datapolicies) @@ -108,29 +108,28 @@ callListDataPolicies(); ## 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-bigquery-datapolicies/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Data_policy_service.create_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.create_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.create_data_policy.js,samples/README.md) | -| Data_policy_service.delete_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.delete_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.delete_data_policy.js,samples/README.md) | -| Data_policy_service.get_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_data_policy.js,samples/README.md) | -| Data_policy_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_iam_policy.js,samples/README.md) | -| Data_policy_service.list_data_policies | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.list_data_policies.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.list_data_policies.js,samples/README.md) | -| Data_policy_service.rename_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.rename_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.rename_data_policy.js,samples/README.md) | -| Data_policy_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.set_iam_policy.js,samples/README.md) | -| Data_policy_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js,samples/README.md) | -| Data_policy_service.update_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.update_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.update_data_policy.js,samples/README.md) | -| Data_policy_service.create_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.create_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.create_data_policy.js,samples/README.md) | -| Data_policy_service.delete_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.delete_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.delete_data_policy.js,samples/README.md) | -| Data_policy_service.get_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_data_policy.js,samples/README.md) | -| Data_policy_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_iam_policy.js,samples/README.md) | -| Data_policy_service.list_data_policies | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.list_data_policies.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.list_data_policies.js,samples/README.md) | -| Data_policy_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.set_iam_policy.js,samples/README.md) | -| Data_policy_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js,samples/README.md) | -| Data_policy_service.update_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.update_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.update_data_policy.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/samples/test/quickstart.js,samples/README.md) | +| Data_policy_service.create_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.create_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.create_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.delete_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.delete_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.delete_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.get_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.get_iam_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.list_data_policies | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.list_data_policies.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.list_data_policies.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.rename_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.rename_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.rename_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.set_iam_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.update_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.update_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1/data_policy_service.update_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.create_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.create_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.create_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.delete_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.delete_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.delete_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.get_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.get_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.get_iam_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.list_data_policies | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.list_data_policies.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.list_data_policies.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.set_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.set_iam_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.set_iam_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.test_iam_permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Data_policy_service.update_data_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.update_data_policy.js) | [![Open in Cloud Shell][shell_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-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.update_data_policy.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/samples/quickstart.js,packages/google-cloud-bigquery-datapolicies/samples/README.md) | diff --git a/packages/google-cloud-bigquery-datapolicies/package.json b/packages/google-cloud-bigquery-datapolicies/package.json index 2643ac6b08d..66d0ee81ed3 100644 --- a/packages/google-cloud-bigquery-datapolicies/package.json +++ b/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/samples/README.md b/packages/google-cloud-bigquery-datapolicies/samples/README.md index 7567e0c6d69..318a488a24b 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/README.md +++ b/packages/google-cloud-bigquery-datapolicies/samples/README.md @@ -30,7 +30,6 @@ * [Data_policy_service.test_iam_permissions](#data_policy_service.test_iam_permissions) * [Data_policy_service.update_data_policy](#data_policy_service.update_data_policy) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -348,23 +347,6 @@ __Usage:__ `node packages/google-cloud-bigquery-datapolicies/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-bigquery-datapolicies/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js index c93277ca374..9a0b98cd727 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/data_policy_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datapolicies library const {DataPolicyServiceClient} = require('@google-cloud/datapolicies').v1; diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datapolicies.v1.json b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datapolicies.v1.json index 2f6625a4fd0..bb3db010c5c 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datapolicies.v1.json +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datapolicies.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datapolicies", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json new file mode 100644 index 00000000000..bb3db010c5c --- /dev/null +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datapolicies.v1.json @@ -0,0 +1,415 @@ +{ + "clientLibrary": { + "name": "nodejs-datapolicies", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.datapolicies.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_CreateDataPolicy_async", + "title": "DataPolicyService createDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Creates a new data policy under a project with the given `dataPolicyId` (used as the display name), policy tag, and data policy type.", + "canonical": true, + "file": "data_policy_service.create_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.CreateDataPolicy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_policy", + "type": ".google.cloud.bigquery.datapolicies.v1.DataPolicy" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "CreateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.CreateDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_UpdateDataPolicy_async", + "title": "DataPolicyService updateDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.", + "canonical": true, + "file": "data_policy_service.update_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.UpdateDataPolicy", + "async": true, + "parameters": [ + { + "name": "data_policy", + "type": ".google.cloud.bigquery.datapolicies.v1.DataPolicy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "UpdateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.UpdateDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_RenameDataPolicy_async", + "title": "DataPolicyService renameDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Renames the id (display name) of the specified data policy.", + "canonical": true, + "file": "data_policy_service.rename_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RenameDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.RenameDataPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "new_data_policy_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "RenameDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.RenameDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_DeleteDataPolicy_async", + "title": "DataPolicyService deleteDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Deletes the data policy specified by its resource name.", + "canonical": true, + "file": "data_policy_service.delete_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.DeleteDataPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "DeleteDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.DeleteDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_GetDataPolicy_async", + "title": "DataPolicyService getDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the data policy specified by its resource name.", + "canonical": true, + "file": "data_policy_service.get_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetDataPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "GetDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_ListDataPolicies_async", + "title": "DataPolicyService listDataPolicies Sample", + "origin": "API_DEFINITION", + "description": " List all of the data policies in the specified parent project.", + "canonical": true, + "file": "data_policy_service.list_data_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataPolicies", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.ListDataPolicies", + "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.bigquery.datapolicies.v1.ListDataPoliciesResponse", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "ListDataPolicies", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.ListDataPolicies", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_GetIamPolicy_async", + "title": "DataPolicyService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy for the specified data policy.", + "canonical": true, + "file": "data_policy_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.GetIamPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_SetIamPolicy_async", + "title": "DataPolicyService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy for the specified data policy.", + "canonical": true, + "file": "data_policy_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.SetIamPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1_generated_DataPolicyService_TestIamPermissions_async", + "title": "DataPolicyService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the caller's permission on the specified data policy resource.", + "canonical": true, + "file": "data_policy_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService.TestIamPermissions", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1.DataPolicyService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js index f42b531534e..96b7f7af785 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/data_policy_service.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datapolicies library const {DataPolicyServiceClient} = require('@google-cloud/bigquery-datapolicies').v1beta1; diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.datapolicies.v1beta1.json b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.datapolicies.v1beta1.json index ca3b5bbdd48..528eb4aecd1 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.datapolicies.v1beta1.json +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata.google.cloud.bigquery.datapolicies.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datapolicies", - "version": "0.3.1", + "version": "0.3.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json new file mode 100644 index 00000000000..528eb4aecd1 --- /dev/null +++ b/packages/google-cloud-bigquery-datapolicies/samples/generated/v1beta1/snippet_metadata_google.cloud.bigquery.datapolicies.v1beta1.json @@ -0,0 +1,367 @@ +{ + "clientLibrary": { + "name": "nodejs-datapolicies", + "version": "0.3.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.datapolicies.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_CreateDataPolicy_async", + "title": "DataPolicyService createDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Creates a new data policy under a project with the given `dataPolicyId` (used as the display name), policy tag, and data policy type.", + "canonical": true, + "file": "data_policy_service.create_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.CreateDataPolicy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_policy", + "type": ".google.cloud.bigquery.datapolicies.v1beta1.DataPolicy" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1beta1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "CreateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.CreateDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_UpdateDataPolicy_async", + "title": "DataPolicyService updateDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.", + "canonical": true, + "file": "data_policy_service.update_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.UpdateDataPolicy", + "async": true, + "parameters": [ + { + "name": "data_policy", + "type": ".google.cloud.bigquery.datapolicies.v1beta1.DataPolicy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1beta1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "UpdateDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.UpdateDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_DeleteDataPolicy_async", + "title": "DataPolicyService deleteDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Deletes the data policy specified by its resource name.", + "canonical": true, + "file": "data_policy_service.delete_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.DeleteDataPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "DeleteDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.DeleteDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_GetDataPolicy_async", + "title": "DataPolicyService getDataPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the data policy specified by its resource name.", + "canonical": true, + "file": "data_policy_service.get_data_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.GetDataPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1beta1.DataPolicy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "GetDataPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.GetDataPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_ListDataPolicies_async", + "title": "DataPolicyService listDataPolicies Sample", + "origin": "API_DEFINITION", + "description": " List all of the data policies in the specified parent project.", + "canonical": true, + "file": "data_policy_service.list_data_policies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataPolicies", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.ListDataPolicies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datapolicies.v1beta1.ListDataPoliciesResponse", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "ListDataPolicies", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.ListDataPolicies", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_GetIamPolicy_async", + "title": "DataPolicyService getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy for the specified data policy.", + "canonical": true, + "file": "data_policy_service.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.GetIamPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_SetIamPolicy_async", + "title": "DataPolicyService setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy for the specified data policy.", + "canonical": true, + "file": "data_policy_service.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.SetIamPolicy", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + }, + { + "regionTag": "bigquerydatapolicy_v1beta1_generated_DataPolicyService_TestIamPermissions_async", + "title": "DataPolicyService testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the caller's permission on the specified data policy resource.", + "canonical": true, + "file": "data_policy_service.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "DataPolicyServiceClient", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyServiceClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService.TestIamPermissions", + "service": { + "shortName": "DataPolicyService", + "fullName": "google.cloud.bigquery.datapolicies.v1beta1.DataPolicyService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-datapolicies/samples/package.json b/packages/google-cloud-bigquery-datapolicies/samples/package.json index 543852d4a70..36efa07c91e 100644 --- a/packages/google-cloud-bigquery-datapolicies/samples/package.json +++ b/packages/google-cloud-bigquery-datapolicies/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-bigquery-datapolicies/src/v1/data_policy_service_client.ts b/packages/google-cloud-bigquery-datapolicies/src/v1/data_policy_service_client.ts index 8441062af85..a52469a59f9 100644 --- a/packages/google-cloud-bigquery-datapolicies/src/v1/data_policy_service_client.ts +++ b/packages/google-cloud-bigquery-datapolicies/src/v1/data_policy_service_client.ts @@ -361,9 +361,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. + * 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/data_policy_service.create_data_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_CreateDataPolicy_async @@ -469,9 +468,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. + * 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/data_policy_service.update_data_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_UpdateDataPolicy_async @@ -569,9 +567,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. + * 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/data_policy_service.rename_data_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_RenameDataPolicy_async @@ -667,9 +664,8 @@ export class DataPolicyServiceClient { * @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/data_policy_service.delete_data_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_DeleteDataPolicy_async @@ -765,9 +761,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. + * 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/data_policy_service.get_data_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_GetDataPolicy_async @@ -866,9 +861,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_policy_service.get_iam_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_GetIamPolicy_async @@ -961,9 +955,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_policy_service.set_iam_policy.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_SetIamPolicy_async @@ -1050,9 +1043,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/data_policy_service.test_iam_permissions.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_TestIamPermissions_async @@ -1150,14 +1142,13 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. * 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 `listDataPoliciesAsync()` * 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. */ listDataPolicies( @@ -1260,13 +1251,12 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datapolicies.v1.DataPolicy|DataPolicy} 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 `listDataPoliciesAsync()` * 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. */ listDataPoliciesStream( @@ -1318,12 +1308,11 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1.DataPolicy | DataPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datapolicies.v1.DataPolicy|DataPolicy}. 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/data_policy_service.list_data_policies.js * region_tag:bigquerydatapolicy_v1_generated_DataPolicyService_ListDataPolicies_async diff --git a/packages/google-cloud-bigquery-datapolicies/src/v1beta1/data_policy_service_client.ts b/packages/google-cloud-bigquery-datapolicies/src/v1beta1/data_policy_service_client.ts index 24588e6524c..af42ff2fa27 100644 --- a/packages/google-cloud-bigquery-datapolicies/src/v1beta1/data_policy_service_client.ts +++ b/packages/google-cloud-bigquery-datapolicies/src/v1beta1/data_policy_service_client.ts @@ -357,9 +357,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy}. + * 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/data_policy_service.create_data_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_CreateDataPolicy_async @@ -465,9 +464,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy}. + * 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/data_policy_service.update_data_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_UpdateDataPolicy_async @@ -563,9 +561,8 @@ export class DataPolicyServiceClient { * @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/data_policy_service.delete_data_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_DeleteDataPolicy_async @@ -661,9 +658,8 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy}. - * 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.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy}. + * 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/data_policy_service.get_data_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_GetDataPolicy_async @@ -762,9 +758,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_policy_service.get_iam_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_GetIamPolicy_async @@ -857,9 +852,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_policy_service.set_iam_policy.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_SetIamPolicy_async @@ -946,9 +940,8 @@ export class DataPolicyServiceClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/data_policy_service.test_iam_permissions.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_TestIamPermissions_async @@ -1038,14 +1031,13 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy}. * 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 `listDataPoliciesAsync()` * 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. */ listDataPolicies( @@ -1140,13 +1132,12 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy} 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 `listDataPoliciesAsync()` * 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. */ listDataPoliciesStream( @@ -1190,12 +1181,11 @@ export class DataPolicyServiceClient { * @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.bigquery.datapolicies.v1beta1.DataPolicy | DataPolicy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datapolicies.v1beta1.DataPolicy|DataPolicy}. 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/data_policy_service.list_data_policies.js * region_tag:bigquerydatapolicy_v1beta1_generated_DataPolicyService_ListDataPolicies_async diff --git a/packages/google-cloud-bigquery-datatransfer/README.md b/packages/google-cloud-bigquery-datatransfer/README.md index 5f1098c1f50..a0ebdaa7331 100644 --- a/packages/google-cloud-bigquery-datatransfer/README.md +++ b/packages/google-cloud-bigquery-datatransfer/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Google BigQuery Data Transfer Service: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Google BigQuery Data Transfer Service: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-bigquery-datatransfer) [![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/bigquery-data-transfer.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-data-transfer) @@ -99,27 +99,26 @@ quickstart(); ## 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-bigquery-datatransfer/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Data_transfer_service.check_valid_creds | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.check_valid_creds.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.check_valid_creds.js,samples/README.md) | -| Data_transfer_service.create_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.create_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.create_transfer_config.js,samples/README.md) | -| Data_transfer_service.delete_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_config.js,samples/README.md) | -| Data_transfer_service.delete_transfer_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_run.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_run.js,samples/README.md) | -| Data_transfer_service.enroll_data_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js,samples/README.md) | -| Data_transfer_service.get_data_source | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_data_source.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_data_source.js,samples/README.md) | -| Data_transfer_service.get_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_config.js,samples/README.md) | -| Data_transfer_service.get_transfer_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_run.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_run.js,samples/README.md) | -| Data_transfer_service.list_data_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_data_sources.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_data_sources.js,samples/README.md) | -| Data_transfer_service.list_transfer_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js,samples/README.md) | -| Data_transfer_service.list_transfer_logs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js,samples/README.md) | -| Data_transfer_service.list_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js,samples/README.md) | -| Data_transfer_service.schedule_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.schedule_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.schedule_transfer_runs.js,samples/README.md) | -| Data_transfer_service.start_manual_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js,samples/README.md) | -| Data_transfer_service.update_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.update_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.update_transfer_config.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/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-bigquery-datatransfer/samples/quickstart.js,samples/README.md) | -| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/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-bigquery-datatransfer/samples/test/quickstart.test.js,samples/README.md) | +| Data_transfer_service.check_valid_creds | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.check_valid_creds.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.check_valid_creds.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.create_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.create_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.create_transfer_config.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.delete_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_config.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.delete_transfer_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_run.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.delete_transfer_run.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.enroll_data_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.get_data_source | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_data_source.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_data_source.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.get_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_config.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.get_transfer_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_run.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.get_transfer_run.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.list_data_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_data_sources.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_data_sources.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.list_transfer_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.list_transfer_logs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.list_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.schedule_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.schedule_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.schedule_transfer_runs.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.start_manual_transfer_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js) | [![Open in Cloud Shell][shell_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.start_manual_transfer_runs.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Data_transfer_service.update_transfer_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.update_transfer_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-bigquery-datatransfer/samples/generated/v1/data_transfer_service.update_transfer_config.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/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-bigquery-datatransfer/samples/quickstart.js,packages/google-cloud-bigquery-datatransfer/samples/README.md) | diff --git a/packages/google-cloud-bigquery-datatransfer/package.json b/packages/google-cloud-bigquery-datatransfer/package.json index 4805c161169..e0e67328b16 100644 --- a/packages/google-cloud-bigquery-datatransfer/package.json +++ b/packages/google-cloud-bigquery-datatransfer/package.json @@ -5,7 +5,7 @@ "license": "Apache-2.0", "author": "Google Inc", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "repository": { "type": "git", @@ -49,14 +49,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.0.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", @@ -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-bigquery-datatransfer/samples/README.md b/packages/google-cloud-bigquery-datatransfer/samples/README.md index 9199f3ac6fc..da46927c6cd 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/README.md +++ b/packages/google-cloud-bigquery-datatransfer/samples/README.md @@ -28,7 +28,6 @@ * [Data_transfer_service.start_manual_transfer_runs](#data_transfer_service.start_manual_transfer_runs) * [Data_transfer_service.update_transfer_config](#data_transfer_service.update_transfer_config) * [Quickstart](#quickstart) - * [Quickstart.test](#quickstart.test) ## Before you begin @@ -312,23 +311,6 @@ __Usage:__ `node packages/google-cloud-bigquery-datatransfer/samples/quickstart.js` ------ - - - - -### Quickstart.test - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-datatransfer/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-bigquery-datatransfer/samples/test/quickstart.test.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-bigquery-datatransfer/samples/test/quickstart.test.js` - - diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js index 46d44200559..89f6a2cf3fd 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.enroll_data_sources.js @@ -36,7 +36,7 @@ function main() { * Data sources that are enrolled. It is required to provide at least one * data source id. */ - // const dataSourceIds = 'abc123' + // const dataSourceIds = ['abc','def'] // Imports the Datatransfer library const {DataTransferServiceClient} = require('@google-cloud/bigquery-data-transfer').v1; diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js index 46875be8cc2..e7ae3d17db9 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_configs.js @@ -37,7 +37,7 @@ function main(parent) { /** * When specified, only configurations of requested data sources are returned. */ - // const dataSourceIds = 'abc123' + // const dataSourceIds = ['abc','def'] /** * Pagination token, which can be used to request a specific page * of `ListTransfersRequest` list results. For multiple-page diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js index c784f6150f5..23595c5aee0 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_logs.js @@ -50,7 +50,7 @@ function main(parent) { * Message types to return. If not populated - INFO, WARNING and ERROR * messages are returned. */ - // const messageTypes = 1234 + // const messageTypes = [1,2,3,4] // Imports the Datatransfer library const {DataTransferServiceClient} = require('@google-cloud/bigquery-data-transfer').v1; diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js index 86461b01514..2cebf50aa7e 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/data_transfer_service.list_transfer_runs.js @@ -38,7 +38,7 @@ function main(parent) { /** * When specified, only transfer runs with requested states are returned. */ - // const states = 1234 + // const states = [1,2,3,4] /** * Pagination token, which can be used to request a specific page * of `ListTransferRunsRequest` list results. For multiple-page diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datatransfer.v1.json b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datatransfer.v1.json index 845172de3de..4fcea5cbd9b 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datatransfer.v1.json +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata.google.cloud.bigquery.datatransfer.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datatransfer", - "version": "3.2.1", + "version": "3.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json new file mode 100644 index 00000000000..4fcea5cbd9b --- /dev/null +++ b/packages/google-cloud-bigquery-datatransfer/samples/generated/v1/snippet_metadata_google.cloud.bigquery.datatransfer.v1.json @@ -0,0 +1,715 @@ +{ + "clientLibrary": { + "name": "nodejs-datatransfer", + "version": "3.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.datatransfer.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_GetDataSource_async", + "title": "DataTransferService getDataSource Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a supported data source and returns its settings.", + "canonical": true, + "file": "data_transfer_service.get_data_source.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataSource", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetDataSource", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.DataSource", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "GetDataSource", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetDataSource", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_ListDataSources_async", + "title": "DataTransferService listDataSources Sample", + "origin": "API_DEFINITION", + "description": " Lists supported data sources and returns their settings.", + "canonical": true, + "file": "data_transfer_service.list_data_sources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataSources", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListDataSources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "ListDataSources", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListDataSources", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_CreateTransferConfig_async", + "title": "DataTransferService createTransferConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a new data transfer configuration.", + "canonical": true, + "file": "data_transfer_service.create_transfer_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 105, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.CreateTransferConfig", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "transfer_config", + "type": ".google.cloud.bigquery.datatransfer.v1.TransferConfig" + }, + { + "name": "authorization_code", + "type": "TYPE_STRING" + }, + { + "name": "version_info", + "type": "TYPE_STRING" + }, + { + "name": "service_account_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.TransferConfig", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "CreateTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.CreateTransferConfig", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_UpdateTransferConfig_async", + "title": "DataTransferService updateTransferConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates a data transfer configuration. All fields must be set, even if they are not updated.", + "canonical": true, + "file": "data_transfer_service.update_transfer_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 101, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.UpdateTransferConfig", + "async": true, + "parameters": [ + { + "name": "transfer_config", + "type": ".google.cloud.bigquery.datatransfer.v1.TransferConfig" + }, + { + "name": "authorization_code", + "type": "TYPE_STRING" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "version_info", + "type": "TYPE_STRING" + }, + { + "name": "service_account_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.TransferConfig", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "UpdateTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.UpdateTransferConfig", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_DeleteTransferConfig_async", + "title": "DataTransferService deleteTransferConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes a data transfer configuration, including any associated transfer runs and logs.", + "canonical": true, + "file": "data_transfer_service.delete_transfer_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "DeleteTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferConfig", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_GetTransferConfig_async", + "title": "DataTransferService getTransferConfig Sample", + "origin": "API_DEFINITION", + "description": " Returns information about a data transfer config.", + "canonical": true, + "file": "data_transfer_service.get_transfer_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.TransferConfig", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "GetTransferConfig", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferConfig", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_ListTransferConfigs_async", + "title": "DataTransferService listTransferConfigs Sample", + "origin": "API_DEFINITION", + "description": " Returns information about all transfer configs owned by a project in the specified location.", + "canonical": true, + "file": "data_transfer_service.list_transfer_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTransferConfigs", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferConfigs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "data_source_ids", + "type": "TYPE_STRING[]" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "ListTransferConfigs", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferConfigs", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_ScheduleTransferRuns_async", + "title": "DataTransferService scheduleTransferRuns Sample", + "origin": "API_DEFINITION", + "description": " Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.", + "canonical": true, + "file": "data_transfer_service.schedule_transfer_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ScheduleTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ScheduleTransferRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "ScheduleTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ScheduleTransferRuns", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_StartManualTransferRuns_async", + "title": "DataTransferService startManualTransferRuns Sample", + "origin": "API_DEFINITION", + "description": " Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.", + "canonical": true, + "file": "data_transfer_service.start_manual_transfer_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartManualTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.StartManualTransferRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "requested_time_range", + "type": ".google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange" + }, + { + "name": "requested_run_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "StartManualTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.StartManualTransferRuns", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_GetTransferRun_async", + "title": "DataTransferService getTransferRun Sample", + "origin": "API_DEFINITION", + "description": " Returns information about the particular transfer run.", + "canonical": true, + "file": "data_transfer_service.get_transfer_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTransferRun", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.TransferRun", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "GetTransferRun", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferRun", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_DeleteTransferRun_async", + "title": "DataTransferService deleteTransferRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes the specified transfer run.", + "canonical": true, + "file": "data_transfer_service.delete_transfer_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTransferRun", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "DeleteTransferRun", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferRun", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_ListTransferRuns_async", + "title": "DataTransferService listTransferRuns Sample", + "origin": "API_DEFINITION", + "description": " Returns information about running and completed transfer runs.", + "canonical": true, + "file": "data_transfer_service.list_transfer_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "states", + "type": "TYPE_ENUM[]" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "run_attempt", + "type": ".google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "ListTransferRuns", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferRuns", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_ListTransferLogs_async", + "title": "DataTransferService listTransferLogs Sample", + "origin": "API_DEFINITION", + "description": " Returns log messages for the transfer run.", + "canonical": true, + "file": "data_transfer_service.list_transfer_logs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTransferLogs", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferLogs", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "message_types", + "type": "TYPE_ENUM[]" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "ListTransferLogs", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferLogs", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_CheckValidCreds_async", + "title": "DataTransferService checkValidCreds Sample", + "origin": "API_DEFINITION", + "description": " Returns true if valid credentials exist for the given data source and requesting user.", + "canonical": true, + "file": "data_transfer_service.check_valid_creds.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckValidCreds", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.CheckValidCreds", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "CheckValidCreds", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.CheckValidCreds", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + }, + { + "regionTag": "bigquerydatatransfer_v1_generated_DataTransferService_EnrollDataSources_async", + "title": "DataTransferService enrollDataSources Sample", + "origin": "API_DEFINITION", + "description": " Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).", + "canonical": true, + "file": "data_transfer_service.enroll_data_sources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "EnrollDataSources", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.EnrollDataSources", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "data_source_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataTransferServiceClient", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient" + }, + "method": { + "shortName": "EnrollDataSources", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService.EnrollDataSources", + "service": { + "shortName": "DataTransferService", + "fullName": "google.cloud.bigquery.datatransfer.v1.DataTransferService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-datatransfer/samples/package.json b/packages/google-cloud-bigquery-datatransfer/samples/package.json index 807cfba855f..2d37a7fe5f4 100644 --- a/packages/google-cloud-bigquery-datatransfer/samples/package.json +++ b/packages/google-cloud-bigquery-datatransfer/samples/package.json @@ -3,7 +3,7 @@ "license": "Apache-2.0", "author": "Google Inc.", "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-bigquery-datatransfer/src/v1/data_transfer_service_client.ts b/packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts index 60c00149fe8..93f07b5d0ae 100644 --- a/packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts +++ b/packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts @@ -397,9 +397,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.DataSource | DataSource}. - * 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.bigquery.datatransfer.v1.DataSource|DataSource}. + * 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/data_transfer_service.get_data_source.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_GetDataSource_async @@ -540,9 +539,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig}. - * 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.bigquery.datatransfer.v1.TransferConfig|TransferConfig}. + * 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/data_transfer_service.create_transfer_config.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_CreateTransferConfig_async @@ -680,9 +678,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig}. - * 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.bigquery.datatransfer.v1.TransferConfig|TransferConfig}. + * 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/data_transfer_service.update_transfer_config.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_UpdateTransferConfig_async @@ -780,9 +777,8 @@ export class DataTransferServiceClient { * @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/data_transfer_service.delete_transfer_config.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_DeleteTransferConfig_async @@ -879,9 +875,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig}. - * 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.bigquery.datatransfer.v1.TransferConfig|TransferConfig}. + * 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/data_transfer_service.get_transfer_config.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_GetTransferConfig_async @@ -988,9 +983,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.ScheduleTransferRunsResponse | ScheduleTransferRunsResponse}. - * 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.bigquery.datatransfer.v1.ScheduleTransferRunsResponse|ScheduleTransferRunsResponse}. + * 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/data_transfer_service.schedule_transfer_runs.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_ScheduleTransferRuns_async @@ -1101,9 +1095,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.StartManualTransferRunsResponse | StartManualTransferRunsResponse}. - * 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.bigquery.datatransfer.v1.StartManualTransferRunsResponse|StartManualTransferRunsResponse}. + * 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/data_transfer_service.start_manual_transfer_runs.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_StartManualTransferRuns_async @@ -1205,9 +1198,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferRun | TransferRun}. - * 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.bigquery.datatransfer.v1.TransferRun|TransferRun}. + * 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/data_transfer_service.get_transfer_run.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_GetTransferRun_async @@ -1305,9 +1297,8 @@ export class DataTransferServiceClient { * @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/data_transfer_service.delete_transfer_run.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_DeleteTransferRun_async @@ -1405,9 +1396,8 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.CheckValidCredsResponse | CheckValidCredsResponse}. - * 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.bigquery.datatransfer.v1.CheckValidCredsResponse|CheckValidCredsResponse}. + * 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/data_transfer_service.check_valid_creds.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_CheckValidCreds_async @@ -1512,9 +1502,8 @@ export class DataTransferServiceClient { * @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/data_transfer_service.enroll_data_sources.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_EnrollDataSources_async @@ -1620,14 +1609,13 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.DataSource | DataSource}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datatransfer.v1.DataSource|DataSource}. * 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 `listDataSourcesAsync()` * 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. */ listDataSources( @@ -1724,13 +1712,12 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.DataSource | DataSource} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datatransfer.v1.DataSource|DataSource} 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 `listDataSourcesAsync()` * 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. */ listDataSourcesStream( @@ -1776,12 +1763,11 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.DataSource | DataSource}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datatransfer.v1.DataSource|DataSource}. 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/data_transfer_service.list_data_sources.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_ListDataSources_async @@ -1830,14 +1816,13 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datatransfer.v1.TransferConfig|TransferConfig}. * 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 `listTransferConfigsAsync()` * 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. */ listTransferConfigs( @@ -1936,13 +1921,12 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datatransfer.v1.TransferConfig|TransferConfig} 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 `listTransferConfigsAsync()` * 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. */ listTransferConfigsStream( @@ -1990,12 +1974,11 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferConfig | TransferConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datatransfer.v1.TransferConfig|TransferConfig}. 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/data_transfer_service.list_transfer_configs.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_ListTransferConfigs_async @@ -2046,14 +2029,13 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferRun | TransferRun}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datatransfer.v1.TransferRun|TransferRun}. * 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 `listTransferRunsAsync()` * 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. */ listTransferRuns( @@ -2155,13 +2137,12 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferRun | TransferRun} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datatransfer.v1.TransferRun|TransferRun} 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 `listTransferRunsAsync()` * 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. */ listTransferRunsStream( @@ -2212,12 +2193,11 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferRun | TransferRun}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datatransfer.v1.TransferRun|TransferRun}. 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/data_transfer_service.list_transfer_runs.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_ListTransferRuns_async @@ -2266,14 +2246,13 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferMessage | TransferMessage}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.datatransfer.v1.TransferMessage|TransferMessage}. * 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 `listTransferLogsAsync()` * 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. */ listTransferLogs( @@ -2373,13 +2352,12 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferMessage | TransferMessage} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.datatransfer.v1.TransferMessage|TransferMessage} 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 `listTransferLogsAsync()` * 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. */ listTransferLogsStream( @@ -2428,12 +2406,11 @@ export class DataTransferServiceClient { * @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.bigquery.datatransfer.v1.TransferMessage | TransferMessage}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.datatransfer.v1.TransferMessage|TransferMessage}. 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/data_transfer_service.list_transfer_logs.js * region_tag:bigquerydatatransfer_v1_generated_DataTransferService_ListTransferLogs_async @@ -2470,8 +2447,7 @@ export class DataTransferServiceClient { * 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 * ``` @@ -2517,12 +2493,11 @@ export class DataTransferServiceClient { * @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-bigquery-reservation/README.md b/packages/google-cloud-bigquery-reservation/README.md index 0ec0461d0ab..4d9b80061cd 100644 --- a/packages/google-cloud-bigquery-reservation/README.md +++ b/packages/google-cloud-bigquery-reservation/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Google BigQuery Reservation: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Google BigQuery Reservation: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-bigquery-reservation) [![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/bigquery-reservation.svg)](https://www.npmjs.org/package/@google-cloud/bigquery-reservation) @@ -95,33 +95,32 @@ listCapacityCommitments(); ## 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-bigquery-reservation/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Reservation_service.create_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_assignment.js,samples/README.md) | -| Reservation_service.create_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_capacity_commitment.js,samples/README.md) | -| Reservation_service.create_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_reservation.js,samples/README.md) | -| Reservation_service.delete_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_assignment.js,samples/README.md) | -| Reservation_service.delete_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_capacity_commitment.js,samples/README.md) | -| Reservation_service.delete_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_reservation.js,samples/README.md) | -| Reservation_service.get_bi_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_bi_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_bi_reservation.js,samples/README.md) | -| Reservation_service.get_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_capacity_commitment.js,samples/README.md) | -| Reservation_service.get_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_reservation.js,samples/README.md) | -| Reservation_service.list_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_assignments.js,samples/README.md) | -| Reservation_service.list_capacity_commitments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_capacity_commitments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_capacity_commitments.js,samples/README.md) | -| Reservation_service.list_reservations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_reservations.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_reservations.js,samples/README.md) | -| Reservation_service.merge_capacity_commitments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js,samples/README.md) | -| Reservation_service.move_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.move_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.move_assignment.js,samples/README.md) | -| Reservation_service.search_all_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.search_all_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.search_all_assignments.js,samples/README.md) | -| Reservation_service.search_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.search_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.search_assignments.js,samples/README.md) | -| Reservation_service.split_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.split_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.split_capacity_commitment.js,samples/README.md) | -| Reservation_service.update_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_assignment.js,samples/README.md) | -| Reservation_service.update_bi_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_bi_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_bi_reservation.js,samples/README.md) | -| Reservation_service.update_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_capacity_commitment.js,samples/README.md) | -| Reservation_service.update_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_reservation.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/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-bigquery-reservation/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/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-bigquery-reservation/samples/test/quickstart.js,samples/README.md) | +| Reservation_service.create_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_assignment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.create_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_capacity_commitment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.create_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.create_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.create_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.delete_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_assignment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.delete_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_capacity_commitment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.delete_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.delete_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.delete_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.get_bi_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_bi_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_bi_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.get_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_capacity_commitment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.get_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.get_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.get_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.list_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_assignments.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.list_capacity_commitments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_capacity_commitments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_capacity_commitments.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.list_reservations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.list_reservations.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.list_reservations.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.merge_capacity_commitments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.move_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.move_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.move_assignment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.search_all_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.search_all_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.search_all_assignments.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.search_assignments | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.search_assignments.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.search_assignments.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.split_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.split_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.split_capacity_commitment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.update_assignment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_assignment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_assignment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.update_bi_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_bi_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_bi_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.update_capacity_commitment | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_capacity_commitment.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_capacity_commitment.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Reservation_service.update_reservation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.update_reservation.js) | [![Open in Cloud Shell][shell_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-bigquery-reservation/samples/generated/v1/reservation_service.update_reservation.js,packages/google-cloud-bigquery-reservation/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/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-bigquery-reservation/samples/quickstart.js,packages/google-cloud-bigquery-reservation/samples/README.md) | diff --git a/packages/google-cloud-bigquery-reservation/package.json b/packages/google-cloud-bigquery-reservation/package.json index fc72cb2f3ec..b6a95854ae3 100644 --- a/packages/google-cloud-bigquery-reservation/package.json +++ b/packages/google-cloud-bigquery-reservation/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.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", @@ -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.0.0", "webpack-cli": "^5.0.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-bigquery-reservation/samples/README.md b/packages/google-cloud-bigquery-reservation/samples/README.md index ad941a328f2..6f60847f1cb 100644 --- a/packages/google-cloud-bigquery-reservation/samples/README.md +++ b/packages/google-cloud-bigquery-reservation/samples/README.md @@ -34,7 +34,6 @@ * [Reservation_service.update_capacity_commitment](#reservation_service.update_capacity_commitment) * [Reservation_service.update_reservation](#reservation_service.update_reservation) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -420,23 +419,6 @@ __Usage:__ `node packages/google-cloud-bigquery-reservation/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigquery-reservation/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-bigquery-reservation/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-bigquery-reservation/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js b/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js index b3a9ae0eae3..9efac5d295e 100644 --- a/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js +++ b/packages/google-cloud-bigquery-reservation/samples/generated/v1/reservation_service.merge_capacity_commitments.js @@ -40,7 +40,7 @@ function main() { * ID is the last portion of capacity commitment name e.g., 'abc' for * projects/myproject/locations/US/capacityCommitments/abc */ - // const capacityCommitmentIds = 'abc123' + // const capacityCommitmentIds = ['abc','def'] // Imports the Reservation library const {ReservationServiceClient} = require('@google-cloud/bigquery-reservation').v1; diff --git a/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata.google.cloud.bigquery.reservation.v1.json b/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata.google.cloud.bigquery.reservation.v1.json index b0e18dd5677..9069e045331 100644 --- a/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata.google.cloud.bigquery.reservation.v1.json +++ b/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata.google.cloud.bigquery.reservation.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-reservation", - "version": "2.2.0", + "version": "2.2.1", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata_google.cloud.bigquery.reservation.v1.json b/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata_google.cloud.bigquery.reservation.v1.json new file mode 100644 index 00000000000..9069e045331 --- /dev/null +++ b/packages/google-cloud-bigquery-reservation/samples/generated/v1/snippet_metadata_google.cloud.bigquery.reservation.v1.json @@ -0,0 +1,967 @@ +{ + "clientLibrary": { + "name": "nodejs-reservation", + "version": "2.2.1", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.bigquery.reservation.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateReservation_async", + "title": "ReservationService createReservation Sample", + "origin": "API_DEFINITION", + "description": " Creates a new reservation resource.", + "canonical": true, + "file": "reservation_service.create_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "reservation_id", + "type": "TYPE_STRING" + }, + { + "name": "reservation", + "type": ".google.cloud.bigquery.reservation.v1.Reservation" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Reservation", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "CreateReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListReservations_async", + "title": "ReservationService listReservations Sample", + "origin": "API_DEFINITION", + "description": " Lists all the reservations for the project in the specified location.", + "canonical": true, + "file": "reservation_service.list_reservations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListReservations", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.ListReservationsResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "ListReservations", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListReservations", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetReservation_async", + "title": "ReservationService getReservation Sample", + "origin": "API_DEFINITION", + "description": " Returns information about the reservation.", + "canonical": true, + "file": "reservation_service.get_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Reservation", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "GetReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async", + "title": "ReservationService deleteReservation Sample", + "origin": "API_DEFINITION", + "description": " Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.", + "canonical": true, + "file": "reservation_service.delete_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "DeleteReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async", + "title": "ReservationService updateReservation Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing reservation resource.", + "canonical": true, + "file": "reservation_service.update_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", + "async": true, + "parameters": [ + { + "name": "reservation", + "type": ".google.cloud.bigquery.reservation.v1.Reservation" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Reservation", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "UpdateReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_async", + "title": "ReservationService createCapacityCommitment Sample", + "origin": "API_DEFINITION", + "description": " Creates a new capacity commitment resource.", + "canonical": true, + "file": "reservation_service.create_capacity_commitment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "capacity_commitment", + "type": ".google.cloud.bigquery.reservation.v1.CapacityCommitment" + }, + { + "name": "enforce_single_admin_project_per_org", + "type": "TYPE_BOOL" + }, + { + "name": "capacity_commitment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.CapacityCommitment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "CreateCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateCapacityCommitment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_async", + "title": "ReservationService listCapacityCommitments Sample", + "origin": "API_DEFINITION", + "description": " Lists all the capacity commitments for the admin project.", + "canonical": true, + "file": "reservation_service.list_capacity_commitments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCapacityCommitments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.ListCapacityCommitmentsResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "ListCapacityCommitments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListCapacityCommitments", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_async", + "title": "ReservationService getCapacityCommitment Sample", + "origin": "API_DEFINITION", + "description": " Returns information about the capacity commitment.", + "canonical": true, + "file": "reservation_service.get_capacity_commitment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.CapacityCommitment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "GetCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetCapacityCommitment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async", + "title": "ReservationService deleteCapacityCommitment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.", + "canonical": true, + "file": "reservation_service.delete_capacity_commitment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "DeleteCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteCapacityCommitment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async", + "title": "ReservationService updateCapacityCommitment Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.", + "canonical": true, + "file": "reservation_service.update_capacity_commitment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", + "async": true, + "parameters": [ + { + "name": "capacity_commitment", + "type": ".google.cloud.bigquery.reservation.v1.CapacityCommitment" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.CapacityCommitment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "UpdateCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateCapacityCommitment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_async", + "title": "ReservationService splitCapacityCommitment Sample", + "origin": "API_DEFINITION", + "description": " Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.", + "canonical": true, + "file": "reservation_service.split_capacity_commitment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SplitCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "slot_count", + "type": "TYPE_INT64" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.SplitCapacityCommitmentResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "SplitCapacityCommitment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SplitCapacityCommitment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async", + "title": "ReservationService mergeCapacityCommitments Sample", + "origin": "API_DEFINITION", + "description": " Merges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments. Attempting to merge capacity commitments of different plan will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.", + "canonical": true, + "file": "reservation_service.merge_capacity_commitments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MergeCapacityCommitments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "capacity_commitment_ids", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.CapacityCommitment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "MergeCapacityCommitments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MergeCapacityCommitments", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_CreateAssignment_async", + "title": "ReservationService createAssignment Sample", + "origin": "API_DEFINITION", + "description": " Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. \"None\" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a \"None\" assignment, use \"none\" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.", + "canonical": true, + "file": "reservation_service.create_assignment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "assignment", + "type": ".google.cloud.bigquery.reservation.v1.Assignment" + }, + { + "name": "assignment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Assignment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "CreateAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.CreateAssignment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_ListAssignments_async", + "title": "ReservationService listAssignments Sample", + "origin": "API_DEFINITION", + "description": " Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard \"-\" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** \"-\" cannot be used for projects nor locations.", + "canonical": true, + "file": "reservation_service.list_assignments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.ListAssignmentsResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "ListAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.ListAssignments", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async", + "title": "ReservationService deleteAssignment Sample", + "origin": "API_DEFINITION", + "description": " Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.", + "canonical": true, + "file": "reservation_service.delete_assignment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "DeleteAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.DeleteAssignment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAssignments_async", + "title": "ReservationService searchAssignments Sample", + "origin": "API_DEFINITION", + "description": " Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** \"-\" cannot be used for projects nor locations.", + "canonical": true, + "file": "reservation_service.search_assignments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.SearchAssignmentsResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "SearchAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAssignments", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_async", + "title": "ReservationService searchAllAssignments Sample", + "origin": "API_DEFINITION", + "description": " Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`.", + "canonical": true, + "file": "reservation_service.search_all_assignments.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchAllAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.SearchAllAssignmentsResponse", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "SearchAllAssignments", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.SearchAllAssignments", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_MoveAssignment_async", + "title": "ReservationService moveAssignment Sample", + "origin": "API_DEFINITION", + "description": " Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.", + "canonical": true, + "file": "reservation_service.move_assignment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "destination_id", + "type": "TYPE_STRING" + }, + { + "name": "assignment_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Assignment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "MoveAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.MoveAssignment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async", + "title": "ReservationService updateAssignment Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing assignment. Only the `priority` field can be updated.", + "canonical": true, + "file": "reservation_service.update_assignment.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", + "async": true, + "parameters": [ + { + "name": "assignment", + "type": ".google.cloud.bigquery.reservation.v1.Assignment" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.Assignment", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "UpdateAssignment", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateAssignment", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_GetBiReservation_async", + "title": "ReservationService getBiReservation Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a BI reservation.", + "canonical": true, + "file": "reservation_service.get_bi_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.BiReservation", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "GetBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.GetBiReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + }, + { + "regionTag": "bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async", + "title": "ReservationService updateBiReservation Sample", + "origin": "API_DEFINITION", + "description": " Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.", + "canonical": true, + "file": "reservation_service.update_bi_reservation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", + "async": true, + "parameters": [ + { + "name": "bi_reservation", + "type": ".google.cloud.bigquery.reservation.v1.BiReservation" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.bigquery.reservation.v1.BiReservation", + "client": { + "shortName": "ReservationServiceClient", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationServiceClient" + }, + "method": { + "shortName": "UpdateBiReservation", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService.UpdateBiReservation", + "service": { + "shortName": "ReservationService", + "fullName": "google.cloud.bigquery.reservation.v1.ReservationService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-bigquery-reservation/samples/package.json b/packages/google-cloud-bigquery-reservation/samples/package.json index b564c72e4f1..3c5b308f71b 100644 --- a/packages/google-cloud-bigquery-reservation/samples/package.json +++ b/packages/google-cloud-bigquery-reservation/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-bigquery-reservation/src/v1/reservation_service_client.ts b/packages/google-cloud-bigquery-reservation/src/v1/reservation_service_client.ts index f6458dfc866..24f15bee88a 100644 --- a/packages/google-cloud-bigquery-reservation/src/v1/reservation_service_client.ts +++ b/packages/google-cloud-bigquery-reservation/src/v1/reservation_service_client.ts @@ -418,9 +418,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation}. - * 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.bigquery.reservation.v1.Reservation|Reservation}. + * 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/reservation_service.create_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_CreateReservation_async @@ -516,9 +515,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation}. - * 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.bigquery.reservation.v1.Reservation|Reservation}. + * 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/reservation_service.get_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_GetReservation_async @@ -616,9 +614,8 @@ export class ReservationServiceClient { * @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/reservation_service.delete_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_DeleteReservation_async @@ -715,9 +712,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation}. - * 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.bigquery.reservation.v1.Reservation|Reservation}. + * 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/reservation_service.update_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_UpdateReservation_async @@ -824,9 +820,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. - * 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.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. + * 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/reservation_service.create_capacity_commitment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_CreateCapacityCommitment_async @@ -926,9 +921,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. - * 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.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. + * 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/reservation_service.get_capacity_commitment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_GetCapacityCommitment_async @@ -1030,9 +1024,8 @@ export class ReservationServiceClient { * @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/reservation_service.delete_capacity_commitment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_DeleteCapacityCommitment_async @@ -1139,9 +1132,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. - * 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.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. + * 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/reservation_service.update_capacity_commitment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_UpdateCapacityCommitment_async @@ -1250,9 +1242,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.SplitCapacityCommitmentResponse | SplitCapacityCommitmentResponse}. - * 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.bigquery.reservation.v1.SplitCapacityCommitmentResponse|SplitCapacityCommitmentResponse}. + * 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/reservation_service.split_capacity_commitment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_SplitCapacityCommitment_async @@ -1364,9 +1355,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. - * 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.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. + * 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/reservation_service.merge_capacity_commitments.js * region_tag:bigqueryreservation_v1_generated_ReservationService_MergeCapacityCommitments_async @@ -1507,9 +1497,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. - * 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.bigquery.reservation.v1.Assignment|Assignment}. + * 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/reservation_service.create_assignment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_CreateAssignment_async @@ -1619,9 +1608,8 @@ export class ReservationServiceClient { * @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/reservation_service.delete_assignment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_DeleteAssignment_async @@ -1731,9 +1719,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. - * 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.bigquery.reservation.v1.Assignment|Assignment}. + * 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/reservation_service.move_assignment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_MoveAssignment_async @@ -1832,9 +1819,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. - * 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.bigquery.reservation.v1.Assignment|Assignment}. + * 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/reservation_service.update_assignment.js * region_tag:bigqueryreservation_v1_generated_ReservationService_UpdateAssignment_async @@ -1930,9 +1916,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.BiReservation | BiReservation}. - * 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.bigquery.reservation.v1.BiReservation|BiReservation}. + * 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/reservation_service.get_bi_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_GetBiReservation_async @@ -2036,9 +2021,8 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.BiReservation | BiReservation}. - * 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.bigquery.reservation.v1.BiReservation|BiReservation}. + * 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/reservation_service.update_bi_reservation.js * region_tag:bigqueryreservation_v1_generated_ReservationService_UpdateBiReservation_async @@ -2139,14 +2123,13 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.reservation.v1.Reservation|Reservation}. * 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 `listReservationsAsync()` * 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. */ listReservations( @@ -2238,13 +2221,12 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.reservation.v1.Reservation|Reservation} 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 `listReservationsAsync()` * 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. */ listReservationsStream( @@ -2285,12 +2267,11 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Reservation | Reservation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.reservation.v1.Reservation|Reservation}. 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/reservation_service.list_reservations.js * region_tag:bigqueryreservation_v1_generated_ReservationService_ListReservations_async @@ -2331,14 +2312,13 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. * 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 `listCapacityCommitmentsAsync()` * 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. */ listCapacityCommitments( @@ -2434,13 +2414,12 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment} 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 `listCapacityCommitmentsAsync()` * 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. */ listCapacityCommitmentsStream( @@ -2481,12 +2460,11 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.CapacityCommitment | CapacityCommitment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.reservation.v1.CapacityCommitment|CapacityCommitment}. 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/reservation_service.list_capacity_commitments.js * region_tag:bigqueryreservation_v1_generated_ReservationService_ListCapacityCommitments_async @@ -2552,14 +2530,13 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. * 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 `listAssignmentsAsync()` * 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. */ listAssignments( @@ -2656,13 +2633,12 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment} 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 `listAssignmentsAsync()` * 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. */ listAssignmentsStream( @@ -2708,12 +2684,11 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. 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/reservation_service.list_assignments.js * region_tag:bigqueryreservation_v1_generated_ReservationService_ListAssignments_async @@ -2785,14 +2760,13 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. * 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 `searchAssignmentsAsync()` * 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 SearchAssignments is deprecated and may be removed in a future version. */ @@ -2899,13 +2873,12 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment} 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 `searchAssignmentsAsync()` * 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 SearchAssignments is deprecated and may be removed in a future version. */ @@ -2961,12 +2934,11 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. 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/reservation_service.search_assignments.js * region_tag:bigqueryreservation_v1_generated_ReservationService_SearchAssignments_async @@ -3041,14 +3013,13 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. + * The first element of the array is Array of {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. * 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 `searchAllAssignmentsAsync()` * 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. */ searchAllAssignments( @@ -3149,13 +3120,12 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment} 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 `searchAllAssignmentsAsync()` * 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. */ searchAllAssignmentsStream( @@ -3205,12 +3175,11 @@ export class ReservationServiceClient { * @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.bigquery.reservation.v1.Assignment | Assignment}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.bigquery.reservation.v1.Assignment|Assignment}. 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/reservation_service.search_all_assignments.js * region_tag:bigqueryreservation_v1_generated_ReservationService_SearchAllAssignments_async diff --git a/packages/google-cloud-billing-budgets/package.json b/packages/google-cloud-billing-budgets/package.json index 03f64481132..eccdcce906b 100644 --- a/packages/google-cloud-billing-budgets/package.json +++ b/packages/google-cloud-billing-budgets/package.json @@ -19,7 +19,8 @@ "@types/sinon": "^10.0.0", "c8": "^7.0.0", "chai": "^4.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", @@ -28,7 +29,7 @@ "mocha": "^9.2.2", "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", - "typescript": "^4.6.4" + "typescript": "^5.1.6" }, "scripts": { "clean": "gts clean", @@ -48,10 +49,10 @@ }, "license": "Apache-2.0", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "dependencies": { - "google-gax": "^3.5.8" + "google-gax": "^4.0.3" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-billing-budgets" } diff --git a/packages/google-cloud-billing-budgets/samples/generated/v1/snippet_metadata_google.cloud.billing.budgets.v1.json b/packages/google-cloud-billing-budgets/samples/generated/v1/snippet_metadata_google.cloud.billing.budgets.v1.json new file mode 100644 index 00000000000..2573a03d81b --- /dev/null +++ b/packages/google-cloud-billing-budgets/samples/generated/v1/snippet_metadata_google.cloud.billing.budgets.v1.json @@ -0,0 +1,231 @@ +{ + "clientLibrary": { + "name": "nodejs-budgets", + "version": "4.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.billing.budgets.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "billingbudgets_v1_generated_BudgetService_CreateBudget_async", + "title": "BudgetService createBudget Sample", + "origin": "API_DEFINITION", + "description": " Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.", + "canonical": true, + "file": "budget_service.create_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.CreateBudget", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "budget", + "type": ".google.cloud.billing.budgets.v1.Budget" + } + ], + "resultType": ".google.cloud.billing.budgets.v1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1.BudgetServiceClient" + }, + "method": { + "shortName": "CreateBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.CreateBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1_generated_BudgetService_UpdateBudget_async", + "title": "BudgetService updateBudget Sample", + "origin": "API_DEFINITION", + "description": " Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.", + "canonical": true, + "file": "budget_service.update_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.UpdateBudget", + "async": true, + "parameters": [ + { + "name": "budget", + "type": ".google.cloud.billing.budgets.v1.Budget" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.billing.budgets.v1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1.BudgetServiceClient" + }, + "method": { + "shortName": "UpdateBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.UpdateBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1_generated_BudgetService_GetBudget_async", + "title": "BudgetService getBudget Sample", + "origin": "API_DEFINITION", + "description": " Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.", + "canonical": true, + "file": "budget_service.get_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.GetBudget", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.budgets.v1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1.BudgetServiceClient" + }, + "method": { + "shortName": "GetBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.GetBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1_generated_BudgetService_ListBudgets_async", + "title": "BudgetService listBudgets Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.", + "canonical": true, + "file": "budget_service.list_budgets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBudgets", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.ListBudgets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.budgets.v1.ListBudgetsResponse", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1.BudgetServiceClient" + }, + "method": { + "shortName": "ListBudgets", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.ListBudgets", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1_generated_BudgetService_DeleteBudget_async", + "title": "BudgetService deleteBudget Sample", + "origin": "API_DEFINITION", + "description": " Deletes a budget. Returns successfully if already deleted.", + "canonical": true, + "file": "budget_service.delete_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.DeleteBudget", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1.BudgetServiceClient" + }, + "method": { + "shortName": "DeleteBudget", + "fullName": "google.cloud.billing.budgets.v1.BudgetService.DeleteBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1.BudgetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-billing-budgets/samples/generated/v1beta1/snippet_metadata_google.cloud.billing.budgets.v1beta1.json b/packages/google-cloud-billing-budgets/samples/generated/v1beta1/snippet_metadata_google.cloud.billing.budgets.v1beta1.json new file mode 100644 index 00000000000..9f41ea98393 --- /dev/null +++ b/packages/google-cloud-billing-budgets/samples/generated/v1beta1/snippet_metadata_google.cloud.billing.budgets.v1beta1.json @@ -0,0 +1,231 @@ +{ + "clientLibrary": { + "name": "nodejs-budgets", + "version": "4.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.billing.budgets.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "billingbudgets_v1beta1_generated_BudgetService_CreateBudget_async", + "title": "BudgetService createBudget Sample", + "origin": "API_DEFINITION", + "description": " Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.", + "canonical": true, + "file": "budget_service.create_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.CreateBudget", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "budget", + "type": ".google.cloud.billing.budgets.v1beta1.Budget" + } + ], + "resultType": ".google.cloud.billing.budgets.v1beta1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetServiceClient" + }, + "method": { + "shortName": "CreateBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.CreateBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1beta1_generated_BudgetService_UpdateBudget_async", + "title": "BudgetService updateBudget Sample", + "origin": "API_DEFINITION", + "description": " Updates a budget and returns the updated budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.", + "canonical": true, + "file": "budget_service.update_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.UpdateBudget", + "async": true, + "parameters": [ + { + "name": "budget", + "type": ".google.cloud.billing.budgets.v1beta1.Budget" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.billing.budgets.v1beta1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetServiceClient" + }, + "method": { + "shortName": "UpdateBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.UpdateBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1beta1_generated_BudgetService_GetBudget_async", + "title": "BudgetService getBudget Sample", + "origin": "API_DEFINITION", + "description": " Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.", + "canonical": true, + "file": "budget_service.get_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.GetBudget", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.budgets.v1beta1.Budget", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetServiceClient" + }, + "method": { + "shortName": "GetBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.GetBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1beta1_generated_BudgetService_ListBudgets_async", + "title": "BudgetService listBudgets Sample", + "origin": "API_DEFINITION", + "description": " Returns a list of budgets for a billing account. WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.", + "canonical": true, + "file": "budget_service.list_budgets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBudgets", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.ListBudgets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.budgets.v1beta1.ListBudgetsResponse", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetServiceClient" + }, + "method": { + "shortName": "ListBudgets", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.ListBudgets", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService" + } + } + } + }, + { + "regionTag": "billingbudgets_v1beta1_generated_BudgetService_DeleteBudget_async", + "title": "BudgetService deleteBudget Sample", + "origin": "API_DEFINITION", + "description": " Deletes a budget. Returns successfully if already deleted.", + "canonical": true, + "file": "budget_service.delete_budget.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.DeleteBudget", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "BudgetServiceClient", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetServiceClient" + }, + "method": { + "shortName": "DeleteBudget", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService.DeleteBudget", + "service": { + "shortName": "BudgetService", + "fullName": "google.cloud.billing.budgets.v1beta1.BudgetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-billing-budgets/samples/package.json b/packages/google-cloud-billing-budgets/samples/package.json index 12e2ad9c8f1..a521fa2180d 100644 --- a/packages/google-cloud-billing-budgets/samples/package.json +++ b/packages/google-cloud-billing-budgets/samples/package.json @@ -9,7 +9,7 @@ "author": "Google LLC", "repository": "googleapis/nodejs-billing-budgets", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "scripts": { "test": "c8 mocha test --timeout=800000" @@ -22,4 +22,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-billing-budgets/src/v1/budget_service_client.ts b/packages/google-cloud-billing-budgets/src/v1/budget_service_client.ts index e37ce132c76..b0f3e6edb2f 100644 --- a/packages/google-cloud-billing-budgets/src/v1/budget_service_client.ts +++ b/packages/google-cloud-billing-budgets/src/v1/budget_service_client.ts @@ -354,9 +354,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget}. - * 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.billing.budgets.v1.Budget|Budget}. + * 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/budget_service.create_budget.js * region_tag:billingbudgets_v1_generated_BudgetService_CreateBudget_async @@ -457,9 +456,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget}. - * 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.billing.budgets.v1.Budget|Budget}. + * 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/budget_service.update_budget.js * region_tag:billingbudgets_v1_generated_BudgetService_UpdateBudget_async @@ -554,9 +552,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget}. - * 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.billing.budgets.v1.Budget|Budget}. + * 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/budget_service.get_budget.js * region_tag:billingbudgets_v1_generated_BudgetService_GetBudget_async @@ -646,9 +643,8 @@ export class BudgetServiceClient { * @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/budget_service.delete_budget.js * region_tag:billingbudgets_v1_generated_BudgetService_DeleteBudget_async @@ -751,14 +747,13 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget}. + * The first element of the array is Array of {@link protos.google.cloud.billing.budgets.v1.Budget|Budget}. * 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 `listBudgetsAsync()` * 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. */ listBudgets( @@ -853,13 +848,12 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.budgets.v1.Budget|Budget} 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 `listBudgetsAsync()` * 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. */ listBudgetsStream( @@ -903,12 +897,11 @@ export class BudgetServiceClient { * @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.billing.budgets.v1.Budget | Budget}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.budgets.v1.Budget|Budget}. 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/budget_service.list_budgets.js * region_tag:billingbudgets_v1_generated_BudgetService_ListBudgets_async diff --git a/packages/google-cloud-billing-budgets/src/v1beta1/budget_service_client.ts b/packages/google-cloud-billing-budgets/src/v1beta1/budget_service_client.ts index 7d466a4b941..3e94418be88 100644 --- a/packages/google-cloud-billing-budgets/src/v1beta1/budget_service_client.ts +++ b/packages/google-cloud-billing-budgets/src/v1beta1/budget_service_client.ts @@ -355,9 +355,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget}. - * 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.billing.budgets.v1beta1.Budget|Budget}. + * 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/budget_service.create_budget.js * region_tag:billingbudgets_v1beta1_generated_BudgetService_CreateBudget_async @@ -464,9 +463,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget}. - * 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.billing.budgets.v1beta1.Budget|Budget}. + * 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/budget_service.update_budget.js * region_tag:billingbudgets_v1beta1_generated_BudgetService_UpdateBudget_async @@ -567,9 +565,8 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget}. - * 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.billing.budgets.v1beta1.Budget|Budget}. + * 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/budget_service.get_budget.js * region_tag:billingbudgets_v1beta1_generated_BudgetService_GetBudget_async @@ -659,9 +656,8 @@ export class BudgetServiceClient { * @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/budget_service.delete_budget.js * region_tag:billingbudgets_v1beta1_generated_BudgetService_DeleteBudget_async @@ -770,14 +766,13 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget}. + * The first element of the array is Array of {@link protos.google.cloud.billing.budgets.v1beta1.Budget|Budget}. * 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 `listBudgetsAsync()` * 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. */ listBudgets( @@ -872,13 +867,12 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.budgets.v1beta1.Budget|Budget} 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 `listBudgetsAsync()` * 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. */ listBudgetsStream( @@ -922,12 +916,11 @@ export class BudgetServiceClient { * @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.billing.budgets.v1beta1.Budget | Budget}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.budgets.v1beta1.Budget|Budget}. 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/budget_service.list_budgets.js * region_tag:billingbudgets_v1beta1_generated_BudgetService_ListBudgets_async diff --git a/packages/google-cloud-billing/package.json b/packages/google-cloud-billing/package.json index 36e9278dc39..46d07907739 100644 --- a/packages/google-cloud-billing/package.json +++ b/packages/google-cloud-billing/package.json @@ -32,14 +32,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.0.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", @@ -50,12 +51,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-billing" } diff --git a/packages/google-cloud-billing/samples/generated/v1/cloud_billing.test_iam_permissions.js b/packages/google-cloud-billing/samples/generated/v1/cloud_billing.test_iam_permissions.js index 49f18706d4f..706187f9fbd 100644 --- a/packages/google-cloud-billing/samples/generated/v1/cloud_billing.test_iam_permissions.js +++ b/packages/google-cloud-billing/samples/generated/v1/cloud_billing.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Billing library const {CloudBillingClient} = require('@google-cloud/billing').v1; diff --git a/packages/google-cloud-billing/samples/generated/v1/snippet_metadata_google.cloud.billing.v1.json b/packages/google-cloud-billing/samples/generated/v1/snippet_metadata_google.cloud.billing.v1.json new file mode 100644 index 00000000000..aa164bf58d5 --- /dev/null +++ b/packages/google-cloud-billing/samples/generated/v1/snippet_metadata_google.cloud.billing.v1.json @@ -0,0 +1,563 @@ +{ + "clientLibrary": { + "name": "nodejs-billing", + "version": "3.4.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.billing.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetBillingAccount_async", + "title": "CloudBilling getBillingAccount Sample", + "origin": "API_DEFINITION", + "description": " Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs/how-to/billing-access).", + "canonical": true, + "file": "cloud_billing.get_billing_account.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.GetBillingAccount", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.BillingAccount", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "GetBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.GetBillingAccount", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_async", + "title": "CloudBilling listBillingAccounts Sample", + "origin": "API_DEFINITION", + "description": " Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).", + "canonical": true, + "file": "cloud_billing.list_billing_accounts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListBillingAccounts", + "fullName": "google.cloud.billing.v1.CloudBilling.ListBillingAccounts", + "async": true, + "parameters": [ + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.ListBillingAccountsResponse", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "ListBillingAccounts", + "fullName": "google.cloud.billing.v1.CloudBilling.ListBillingAccounts", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_async", + "title": "CloudBilling updateBillingAccount Sample", + "origin": "API_DEFINITION", + "description": " Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account.", + "canonical": true, + "file": "cloud_billing.update_billing_account.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateBillingAccount", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "account", + "type": ".google.cloud.billing.v1.BillingAccount" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.billing.v1.BillingAccount", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "UpdateBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateBillingAccount", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_async", + "title": "CloudBilling createBillingAccount Sample", + "origin": "API_DEFINITION", + "description": " This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned as a reseller account.", + "canonical": true, + "file": "cloud_billing.create_billing_account.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 56, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.CreateBillingAccount", + "async": true, + "parameters": [ + { + "name": "billing_account", + "type": ".google.cloud.billing.v1.BillingAccount" + } + ], + "resultType": ".google.cloud.billing.v1.BillingAccount", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "CreateBillingAccount", + "fullName": "google.cloud.billing.v1.CloudBilling.CreateBillingAccount", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_async", + "title": "CloudBilling listProjectBillingInfo Sample", + "origin": "API_DEFINITION", + "description": " Lists the projects associated with a billing account. The current authenticated user must have the `billing.resourceAssociations.list` IAM permission, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).", + "canonical": true, + "file": "cloud_billing.list_project_billing_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.ListProjectBillingInfo", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.ListProjectBillingInfoResponse", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "ListProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.ListProjectBillingInfo", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_async", + "title": "CloudBilling getProjectBillingInfo Sample", + "origin": "API_DEFINITION", + "description": " Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.", + "canonical": true, + "file": "cloud_billing.get_project_billing_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.GetProjectBillingInfo", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.ProjectBillingInfo", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "GetProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.GetProjectBillingInfo", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_async", + "title": "CloudBilling updateProjectBillingInfo Sample", + "origin": "API_DEFINITION", + "description": " Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Cloud Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://cloud.google.com/billing/docs/how-to/billing-access). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.", + "canonical": true, + "file": "cloud_billing.update_project_billing_info.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateProjectBillingInfo", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "project_billing_info", + "type": ".google.cloud.billing.v1.ProjectBillingInfo" + } + ], + "resultType": ".google.cloud.billing.v1.ProjectBillingInfo", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "UpdateProjectBillingInfo", + "fullName": "google.cloud.billing.v1.CloudBilling.UpdateProjectBillingInfo", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_GetIamPolicy_async", + "title": "CloudBilling getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).", + "canonical": true, + "file": "cloud_billing.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.billing.v1.CloudBilling.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.billing.v1.CloudBilling.GetIamPolicy", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_SetIamPolicy_async", + "title": "CloudBilling setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access).", + "canonical": true, + "file": "cloud_billing.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.billing.v1.CloudBilling.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.billing.v1.CloudBilling.SetIamPolicy", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudBilling_TestIamPermissions_async", + "title": "CloudBilling testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.", + "canonical": true, + "file": "cloud_billing.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.billing.v1.CloudBilling.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "CloudBillingClient", + "fullName": "google.cloud.billing.v1.CloudBillingClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.billing.v1.CloudBilling.TestIamPermissions", + "service": { + "shortName": "CloudBilling", + "fullName": "google.cloud.billing.v1.CloudBilling" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListServices_async", + "title": "CloudBilling listServices Sample", + "origin": "API_DEFINITION", + "description": " Lists all public cloud services.", + "canonical": true, + "file": "cloud_catalog.list_services.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListServices", + "fullName": "google.cloud.billing.v1.CloudCatalog.ListServices", + "async": true, + "parameters": [ + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.ListServicesResponse", + "client": { + "shortName": "CloudCatalogClient", + "fullName": "google.cloud.billing.v1.CloudCatalogClient" + }, + "method": { + "shortName": "ListServices", + "fullName": "google.cloud.billing.v1.CloudCatalog.ListServices", + "service": { + "shortName": "CloudCatalog", + "fullName": "google.cloud.billing.v1.CloudCatalog" + } + } + } + }, + { + "regionTag": "cloudbilling_v1_generated_CloudCatalog_ListSkus_async", + "title": "CloudBilling listSkus Sample", + "origin": "API_DEFINITION", + "description": " Lists all publicly available SKUs for a given cloud service.", + "canonical": true, + "file": "cloud_catalog.list_skus.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSkus", + "fullName": "google.cloud.billing.v1.CloudCatalog.ListSkus", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "start_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "end_time", + "type": ".google.protobuf.Timestamp" + }, + { + "name": "currency_code", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.billing.v1.ListSkusResponse", + "client": { + "shortName": "CloudCatalogClient", + "fullName": "google.cloud.billing.v1.CloudCatalogClient" + }, + "method": { + "shortName": "ListSkus", + "fullName": "google.cloud.billing.v1.CloudCatalog.ListSkus", + "service": { + "shortName": "CloudCatalog", + "fullName": "google.cloud.billing.v1.CloudCatalog" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-billing/samples/package.json b/packages/google-cloud-billing/samples/package.json index 49984ade98e..af4e486de30 100644 --- a/packages/google-cloud-billing/samples/package.json +++ b/packages/google-cloud-billing/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-billing/src/v1/cloud_billing_client.ts b/packages/google-cloud-billing/src/v1/cloud_billing_client.ts index 1b1edb1d2dc..65e967cbfb0 100644 --- a/packages/google-cloud-billing/src/v1/cloud_billing_client.ts +++ b/packages/google-cloud-billing/src/v1/cloud_billing_client.ts @@ -369,9 +369,8 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount}. - * 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.billing.v1.BillingAccount|BillingAccount}. + * 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/cloud_billing.get_billing_account.js * region_tag:cloudbilling_v1_generated_CloudBilling_GetBillingAccount_async @@ -471,9 +470,8 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount}. - * 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.billing.v1.BillingAccount|BillingAccount}. + * 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/cloud_billing.update_billing_account.js * region_tag:cloudbilling_v1_generated_CloudBilling_UpdateBillingAccount_async @@ -579,9 +577,8 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount}. - * 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.billing.v1.BillingAccount|BillingAccount}. + * 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/cloud_billing.create_billing_account.js * region_tag:cloudbilling_v1_generated_CloudBilling_CreateBillingAccount_async @@ -671,9 +668,8 @@ export class CloudBillingClient { * @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.billing.v1.ProjectBillingInfo | ProjectBillingInfo}. - * 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.billing.v1.ProjectBillingInfo|ProjectBillingInfo}. + * 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/cloud_billing.get_project_billing_info.js * region_tag:cloudbilling_v1_generated_CloudBilling_GetProjectBillingInfo_async @@ -797,9 +793,8 @@ export class CloudBillingClient { * @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.billing.v1.ProjectBillingInfo | ProjectBillingInfo}. - * 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.billing.v1.ProjectBillingInfo|ProjectBillingInfo}. + * 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/cloud_billing.update_project_billing_info.js * region_tag:cloudbilling_v1_generated_CloudBilling_UpdateProjectBillingInfo_async @@ -905,9 +900,8 @@ export class CloudBillingClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/cloud_billing.get_iam_policy.js * region_tag:cloudbilling_v1_generated_CloudBilling_GetIamPolicy_async @@ -1004,9 +998,8 @@ export class CloudBillingClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/cloud_billing.set_iam_policy.js * region_tag:cloudbilling_v1_generated_CloudBilling_SetIamPolicy_async @@ -1095,9 +1088,8 @@ export class CloudBillingClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/cloud_billing.test_iam_permissions.js * region_tag:cloudbilling_v1_generated_CloudBilling_TestIamPermissions_async @@ -1193,14 +1185,13 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount}. + * The first element of the array is Array of {@link protos.google.cloud.billing.v1.BillingAccount|BillingAccount}. * 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 `listBillingAccountsAsync()` * 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. */ listBillingAccounts( @@ -1295,13 +1286,12 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.v1.BillingAccount|BillingAccount} 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 `listBillingAccountsAsync()` * 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. */ listBillingAccountsStream( @@ -1345,12 +1335,11 @@ export class CloudBillingClient { * @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.billing.v1.BillingAccount | BillingAccount}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.v1.BillingAccount|BillingAccount}. 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/cloud_billing.list_billing_accounts.js * region_tag:cloudbilling_v1_generated_CloudBilling_ListBillingAccounts_async @@ -1394,14 +1383,13 @@ export class CloudBillingClient { * @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.billing.v1.ProjectBillingInfo | ProjectBillingInfo}. + * The first element of the array is Array of {@link protos.google.cloud.billing.v1.ProjectBillingInfo|ProjectBillingInfo}. * 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 `listProjectBillingInfoAsync()` * 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. */ listProjectBillingInfo( @@ -1501,13 +1489,12 @@ export class CloudBillingClient { * @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.billing.v1.ProjectBillingInfo | ProjectBillingInfo} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.v1.ProjectBillingInfo|ProjectBillingInfo} 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 `listProjectBillingInfoAsync()` * 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. */ listProjectBillingInfoStream( @@ -1552,12 +1539,11 @@ export class CloudBillingClient { * @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.billing.v1.ProjectBillingInfo | ProjectBillingInfo}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.v1.ProjectBillingInfo|ProjectBillingInfo}. 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/cloud_billing.list_project_billing_info.js * region_tag:cloudbilling_v1_generated_CloudBilling_ListProjectBillingInfo_async diff --git a/packages/google-cloud-billing/src/v1/cloud_catalog_client.ts b/packages/google-cloud-billing/src/v1/cloud_catalog_client.ts index be58d3310db..288e36a1d6a 100644 --- a/packages/google-cloud-billing/src/v1/cloud_catalog_client.ts +++ b/packages/google-cloud-billing/src/v1/cloud_catalog_client.ts @@ -358,14 +358,13 @@ export class CloudCatalogClient { * @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.billing.v1.Service | Service}. + * The first element of the array is Array of {@link protos.google.cloud.billing.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( @@ -446,13 +445,12 @@ export class CloudCatalogClient { * @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.billing.v1.Service | Service} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.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( @@ -488,12 +486,11 @@ export class CloudCatalogClient { * @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.billing.v1.Service | Service}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.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/cloud_catalog.list_services.js * region_tag:cloudbilling_v1_generated_CloudCatalog_ListServices_async @@ -550,14 +547,13 @@ export class CloudCatalogClient { * @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.billing.v1.Sku | Sku}. + * The first element of the array is Array of {@link protos.google.cloud.billing.v1.Sku|Sku}. * 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 `listSkusAsync()` * 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. */ listSkus( @@ -661,13 +657,12 @@ export class CloudCatalogClient { * @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.billing.v1.Sku | Sku} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.billing.v1.Sku|Sku} 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 `listSkusAsync()` * 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. */ listSkusStream( @@ -728,12 +723,11 @@ export class CloudCatalogClient { * @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.billing.v1.Sku | Sku}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.billing.v1.Sku|Sku}. 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/cloud_catalog.list_skus.js * region_tag:cloudbilling_v1_generated_CloudCatalog_ListSkus_async diff --git a/packages/google-cloud-binaryauthorization/README.md b/packages/google-cloud-binaryauthorization/README.md index 164a0e97d47..cd77c6ac6c7 100644 --- a/packages/google-cloud-binaryauthorization/README.md +++ b/packages/google-cloud-binaryauthorization/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Binary Authorization: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Binary Authorization: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-binaryauthorization) [![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/binary-authorization.svg)](https://www.npmjs.org/package/@google-cloud/binary-authorization) @@ -82,29 +82,28 @@ listAttestors(); ## 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-binaryauthorization/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Binauthz_management_service_v1.create_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.create_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.create_attestor.js,samples/README.md) | -| Binauthz_management_service_v1.delete_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.delete_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.delete_attestor.js,samples/README.md) | -| Binauthz_management_service_v1.get_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_attestor.js,samples/README.md) | -| Binauthz_management_service_v1.get_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_policy.js,samples/README.md) | -| Binauthz_management_service_v1.list_attestors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.list_attestors.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.list_attestors.js,samples/README.md) | -| Binauthz_management_service_v1.update_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_attestor.js,samples/README.md) | -| Binauthz_management_service_v1.update_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_policy.js,samples/README.md) | -| System_policy_v1.get_system_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/system_policy_v1.get_system_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/system_policy_v1.get_system_policy.js,samples/README.md) | -| Validation_helper_v1.validate_attestation_occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/validation_helper_v1.validate_attestation_occurrence.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/validation_helper_v1.validate_attestation_occurrence.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.create_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.create_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.create_attestor.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.delete_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.delete_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.delete_attestor.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.get_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_attestor.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.get_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_policy.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.list_attestors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.list_attestors.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.list_attestors.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.update_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_attestor.js,samples/README.md) | -| Binauthz_management_service_v1_beta1.update_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_policy.js,samples/README.md) | -| System_policy_v1_beta1.get_system_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/system_policy_v1_beta1.get_system_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/system_policy_v1_beta1.get_system_policy.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/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-binaryauthorization/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/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-binaryauthorization/samples/test/quickstart.js,samples/README.md) | +| Binauthz_management_service_v1.create_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.create_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.create_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.delete_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.delete_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.delete_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.get_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.get_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.get_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.list_attestors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.list_attestors.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.list_attestors.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.update_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1.update_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/binauthz_management_service_v1.update_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| System_policy_v1.get_system_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/system_policy_v1.get_system_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/system_policy_v1.get_system_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Validation_helper_v1.validate_attestation_occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1/validation_helper_v1.validate_attestation_occurrence.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1/validation_helper_v1.validate_attestation_occurrence.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.create_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.create_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.create_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.delete_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.delete_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.delete_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.get_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.get_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.get_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.list_attestors | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.list_attestors.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.list_attestors.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.update_attestor | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_attestor.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_attestor.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Binauthz_management_service_v1_beta1.update_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/binauthz_management_service_v1_beta1.update_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| System_policy_v1_beta1.get_system_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/system_policy_v1_beta1.get_system_policy.js) | [![Open in Cloud Shell][shell_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-binaryauthorization/samples/generated/v1beta1/system_policy_v1_beta1.get_system_policy.js,packages/google-cloud-binaryauthorization/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/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-binaryauthorization/samples/quickstart.js,packages/google-cloud-binaryauthorization/samples/README.md) | diff --git a/packages/google-cloud-binaryauthorization/package.json b/packages/google-cloud-binaryauthorization/package.json index 205a965ca16..2281c202383 100644 --- a/packages/google-cloud-binaryauthorization/package.json +++ b/packages/google-cloud-binaryauthorization/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.4.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-binaryauthorization" } diff --git a/packages/google-cloud-binaryauthorization/samples/README.md b/packages/google-cloud-binaryauthorization/samples/README.md index 462877471a5..b58bbc43d69 100644 --- a/packages/google-cloud-binaryauthorization/samples/README.md +++ b/packages/google-cloud-binaryauthorization/samples/README.md @@ -30,7 +30,6 @@ * [Binauthz_management_service_v1_beta1.update_policy](#binauthz_management_service_v1_beta1.update_policy) * [System_policy_v1_beta1.get_system_policy](#system_policy_v1_beta1.get_system_policy) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -348,23 +347,6 @@ __Usage:__ `node packages/google-cloud-binaryauthorization/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-binaryauthorization/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-binaryauthorization/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-binaryauthorization/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata.google.cloud.binaryauthorization.v1.json b/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata.google.cloud.binaryauthorization.v1.json index da1759d8a23..5df7cbd3a9f 100644 --- a/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata.google.cloud.binaryauthorization.v1.json +++ b/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata.google.cloud.binaryauthorization.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-binaryauthorization", - "version": "2.4.0", + "version": "2.5.0", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata_google.cloud.binaryauthorization.v1.json b/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata_google.cloud.binaryauthorization.v1.json new file mode 100644 index 00000000000..5df7cbd3a9f --- /dev/null +++ b/packages/google-cloud-binaryauthorization/samples/generated/v1/snippet_metadata_google.cloud.binaryauthorization.v1.json @@ -0,0 +1,403 @@ +{ + "clientLibrary": { + "name": "nodejs-binaryauthorization", + "version": "2.5.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.binaryauthorization.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_GetPolicy_async", + "title": "BinauthzManagementServiceV1 getPolicy Sample", + "origin": "API_DEFINITION", + "description": " A [policy][google.cloud.binaryauthorization.v1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1.Attestor] that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the [policy][google.cloud.binaryauthorization.v1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1.Policy] if the project does not have one.", + "canonical": true, + "file": "binauthz_management_service_v1.get_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPolicy", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.GetPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Policy", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "GetPolicy", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.GetPolicy", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_UpdatePolicy_async", + "title": "BinauthzManagementServiceV1 updatePolicy Sample", + "origin": "API_DEFINITION", + "description": " Creates or updates a project's [policy][google.cloud.binaryauthorization.v1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1.Policy]. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.", + "canonical": true, + "file": "binauthz_management_service_v1.update_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePolicy", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.UpdatePolicy", + "async": true, + "parameters": [ + { + "name": "policy", + "type": ".google.cloud.binaryauthorization.v1.Policy" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Policy", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "UpdatePolicy", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.UpdatePolicy", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_CreateAttestor_async", + "title": "BinauthzManagementServiceV1 createAttestor Sample", + "origin": "API_DEFINITION", + "description": " Creates an [attestor][google.cloud.binaryauthorization.v1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1.Attestor] already exists.", + "canonical": true, + "file": "binauthz_management_service_v1.create_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.CreateAttestor", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "attestor_id", + "type": "TYPE_STRING" + }, + { + "name": "attestor", + "type": ".google.cloud.binaryauthorization.v1.Attestor" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "CreateAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.CreateAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_GetAttestor_async", + "title": "BinauthzManagementServiceV1 getAttestor Sample", + "origin": "API_DEFINITION", + "description": " Gets an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1.get_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.GetAttestor", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "GetAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.GetAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_UpdateAttestor_async", + "title": "BinauthzManagementServiceV1 updateAttestor Sample", + "origin": "API_DEFINITION", + "description": " Updates an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1.update_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.UpdateAttestor", + "async": true, + "parameters": [ + { + "name": "attestor", + "type": ".google.cloud.binaryauthorization.v1.Attestor" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "UpdateAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.UpdateAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_ListAttestors_async", + "title": "BinauthzManagementServiceV1 listAttestors Sample", + "origin": "API_DEFINITION", + "description": " Lists [attestors][google.cloud.binaryauthorization.v1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1.list_attestors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAttestors", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.ListAttestors", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.ListAttestorsResponse", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "ListAttestors", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.ListAttestors", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_BinauthzManagementServiceV1_DeleteAttestor_async", + "title": "BinauthzManagementServiceV1 deleteAttestor Sample", + "origin": "API_DEFINITION", + "description": " Deletes an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1.delete_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.DeleteAttestor", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "BinauthzManagementServiceV1Client", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1Client" + }, + "method": { + "shortName": "DeleteAttestor", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1.DeleteAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1", + "fullName": "google.cloud.binaryauthorization.v1.BinauthzManagementServiceV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_SystemPolicyV1_GetSystemPolicy_async", + "title": "BinauthzManagementServiceV1 getSystemPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the current system policy in the specified location.", + "canonical": true, + "file": "system_policy_v1.get_system_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSystemPolicy", + "fullName": "google.cloud.binaryauthorization.v1.SystemPolicyV1.GetSystemPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.Policy", + "client": { + "shortName": "SystemPolicyV1Client", + "fullName": "google.cloud.binaryauthorization.v1.SystemPolicyV1Client" + }, + "method": { + "shortName": "GetSystemPolicy", + "fullName": "google.cloud.binaryauthorization.v1.SystemPolicyV1.GetSystemPolicy", + "service": { + "shortName": "SystemPolicyV1", + "fullName": "google.cloud.binaryauthorization.v1.SystemPolicyV1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1_generated_ValidationHelperV1_ValidateAttestationOccurrence_async", + "title": "BinauthzManagementServiceV1 validateAttestationOccurrence Sample", + "origin": "API_DEFINITION", + "description": " Returns whether the given Attestation for the given image URI was signed by the given Attestor", + "canonical": true, + "file": "validation_helper_v1.validate_attestation_occurrence.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ValidateAttestationOccurrence", + "fullName": "google.cloud.binaryauthorization.v1.ValidationHelperV1.ValidateAttestationOccurrence", + "async": true, + "parameters": [ + { + "name": "attestor", + "type": "TYPE_STRING" + }, + { + "name": "attestation", + "type": ".grafeas.v1.AttestationOccurrence" + }, + { + "name": "occurrence_note", + "type": "TYPE_STRING" + }, + { + "name": "occurrence_resource_uri", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1.ValidateAttestationOccurrenceResponse", + "client": { + "shortName": "ValidationHelperV1Client", + "fullName": "google.cloud.binaryauthorization.v1.ValidationHelperV1Client" + }, + "method": { + "shortName": "ValidateAttestationOccurrence", + "fullName": "google.cloud.binaryauthorization.v1.ValidationHelperV1.ValidateAttestationOccurrence", + "service": { + "shortName": "ValidationHelperV1", + "fullName": "google.cloud.binaryauthorization.v1.ValidationHelperV1" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata.google.cloud.binaryauthorization.v1beta1.json b/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata.google.cloud.binaryauthorization.v1beta1.json index 663fa4b6b9f..fbdce831790 100644 --- a/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata.google.cloud.binaryauthorization.v1beta1.json +++ b/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata.google.cloud.binaryauthorization.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-binaryauthorization", - "version": "2.4.0", + "version": "2.5.0", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json b/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json new file mode 100644 index 00000000000..fbdce831790 --- /dev/null +++ b/packages/google-cloud-binaryauthorization/samples/generated/v1beta1/snippet_metadata_google.cloud.binaryauthorization.v1beta1.json @@ -0,0 +1,351 @@ +{ + "clientLibrary": { + "name": "nodejs-binaryauthorization", + "version": "2.5.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.binaryauthorization.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_GetPolicy_async", + "title": "BinauthzManagementServiceV1Beta1 getPolicy Sample", + "origin": "API_DEFINITION", + "description": " A [policy][google.cloud.binaryauthorization.v1beta1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1beta1.Attestor] that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the [policy][google.cloud.binaryauthorization.v1beta1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1beta1.Policy] if the project does not have one.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.get_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.GetPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Policy", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "GetPolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.GetPolicy", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_UpdatePolicy_async", + "title": "BinauthzManagementServiceV1Beta1 updatePolicy Sample", + "origin": "API_DEFINITION", + "description": " Creates or updates a project's [policy][google.cloud.binaryauthorization.v1beta1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1beta1.Policy]. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.update_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.UpdatePolicy", + "async": true, + "parameters": [ + { + "name": "policy", + "type": ".google.cloud.binaryauthorization.v1beta1.Policy" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Policy", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "UpdatePolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.UpdatePolicy", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_CreateAttestor_async", + "title": "BinauthzManagementServiceV1Beta1 createAttestor Sample", + "origin": "API_DEFINITION", + "description": " Creates an [attestor][google.cloud.binaryauthorization.v1beta1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1beta1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1beta1.Attestor] already exists.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.create_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.CreateAttestor", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "attestor_id", + "type": "TYPE_STRING" + }, + { + "name": "attestor", + "type": ".google.cloud.binaryauthorization.v1beta1.Attestor" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "CreateAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.CreateAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_GetAttestor_async", + "title": "BinauthzManagementServiceV1Beta1 getAttestor Sample", + "origin": "API_DEFINITION", + "description": " Gets an [attestor][google.cloud.binaryauthorization.v1beta1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1beta1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.get_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.GetAttestor", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "GetAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.GetAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_UpdateAttestor_async", + "title": "BinauthzManagementServiceV1Beta1 updateAttestor Sample", + "origin": "API_DEFINITION", + "description": " Updates an [attestor][google.cloud.binaryauthorization.v1beta1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1beta1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.update_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.UpdateAttestor", + "async": true, + "parameters": [ + { + "name": "attestor", + "type": ".google.cloud.binaryauthorization.v1beta1.Attestor" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Attestor", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "UpdateAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.UpdateAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_ListAttestors_async", + "title": "BinauthzManagementServiceV1Beta1 listAttestors Sample", + "origin": "API_DEFINITION", + "description": " Lists [attestors][google.cloud.binaryauthorization.v1beta1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.list_attestors.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAttestors", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.ListAttestors", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "ListAttestors", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.ListAttestors", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_DeleteAttestor_async", + "title": "BinauthzManagementServiceV1Beta1 deleteAttestor Sample", + "origin": "API_DEFINITION", + "description": " Deletes an [attestor][google.cloud.binaryauthorization.v1beta1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1beta1.Attestor] does not exist.", + "canonical": true, + "file": "binauthz_management_service_v1_beta1.delete_attestor.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.DeleteAttestor", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "BinauthzManagementServiceV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1Client" + }, + "method": { + "shortName": "DeleteAttestor", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1.DeleteAttestor", + "service": { + "shortName": "BinauthzManagementServiceV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.BinauthzManagementServiceV1Beta1" + } + } + } + }, + { + "regionTag": "binaryauthorization_v1beta1_generated_SystemPolicyV1Beta1_GetSystemPolicy_async", + "title": "BinauthzManagementServiceV1Beta1 getSystemPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the current system policy in the specified location.", + "canonical": true, + "file": "system_policy_v1_beta1.get_system_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSystemPolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.SystemPolicyV1Beta1.GetSystemPolicy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.binaryauthorization.v1beta1.Policy", + "client": { + "shortName": "SystemPolicyV1Beta1Client", + "fullName": "google.cloud.binaryauthorization.v1beta1.SystemPolicyV1Beta1Client" + }, + "method": { + "shortName": "GetSystemPolicy", + "fullName": "google.cloud.binaryauthorization.v1beta1.SystemPolicyV1Beta1.GetSystemPolicy", + "service": { + "shortName": "SystemPolicyV1Beta1", + "fullName": "google.cloud.binaryauthorization.v1beta1.SystemPolicyV1Beta1" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-binaryauthorization/samples/package.json b/packages/google-cloud-binaryauthorization/samples/package.json index a312db0c2e3..b9f338af923 100644 --- a/packages/google-cloud-binaryauthorization/samples/package.json +++ b/packages/google-cloud-binaryauthorization/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-binaryauthorization/src/v1/binauthz_management_service_v1_client.ts b/packages/google-cloud-binaryauthorization/src/v1/binauthz_management_service_v1_client.ts index a321864478b..f9c37755fe8 100644 --- a/packages/google-cloud-binaryauthorization/src/v1/binauthz_management_service_v1_client.ts +++ b/packages/google-cloud-binaryauthorization/src/v1/binauthz_management_service_v1_client.ts @@ -43,8 +43,8 @@ const version = require('../../../package.json').version; * * This API implements a REST model with the following objects: * - * * {@link google.cloud.binaryauthorization.v1.Policy|Policy} - * * {@link google.cloud.binaryauthorization.v1.Attestor|Attestor} + * * {@link protos.google.cloud.binaryauthorization.v1.Policy|Policy} + * * {@link protos.google.cloud.binaryauthorization.v1.Attestor|Attestor} * @class * @memberof v1 */ @@ -352,25 +352,24 @@ export class BinauthzManagementServiceV1Client { // -- Service calls -- // ------------------- /** - * A {@link google.cloud.binaryauthorization.v1.Policy|policy} specifies the {@link google.cloud.binaryauthorization.v1.Attestor|attestors} that must attest to + * A {@link protos.google.cloud.binaryauthorization.v1.Policy|policy} specifies the {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors} that must attest to * a container image, before the project is allowed to deploy that * image. There is at most one policy per project. All image admission * requests are permitted if a project has no policy. * - * Gets the {@link google.cloud.binaryauthorization.v1.Policy|policy} for this project. Returns a default - * {@link google.cloud.binaryauthorization.v1.Policy|policy} if the project does not have one. + * Gets the {@link protos.google.cloud.binaryauthorization.v1.Policy|policy} for this project. Returns a default + * {@link protos.google.cloud.binaryauthorization.v1.Policy|policy} if the project does not have one. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The resource name of the {@link google.cloud.binaryauthorization.v1.Policy|policy} to retrieve, + * Required. The resource name of the {@link protos.google.cloud.binaryauthorization.v1.Policy|policy} to retrieve, * in the format `projects/* /policy`. * @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.binaryauthorization.v1.Policy | Policy}. - * 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.binaryauthorization.v1.Policy|Policy}. + * 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/binauthz_management_service_v1.get_policy.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_GetPolicy_async @@ -450,8 +449,8 @@ export class BinauthzManagementServiceV1Client { return this.innerApiCalls.getPolicy(request, options, callback); } /** - * Creates or updates a project's {@link google.cloud.binaryauthorization.v1.Policy|policy}, and returns a copy of the - * new {@link google.cloud.binaryauthorization.v1.Policy|policy}. A policy is always updated as a whole, to avoid race + * Creates or updates a project's {@link protos.google.cloud.binaryauthorization.v1.Policy|policy}, and returns a copy of the + * new {@link protos.google.cloud.binaryauthorization.v1.Policy|policy}. A policy is always updated as a whole, to avoid race * conditions with concurrent policy enforcement (or management!) * requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT * if the request is malformed. @@ -459,15 +458,14 @@ export class BinauthzManagementServiceV1Client { * @param {Object} request * The request object that will be sent. * @param {google.cloud.binaryauthorization.v1.Policy} request.policy - * Required. A new or updated {@link google.cloud.binaryauthorization.v1.Policy|policy} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1.Policy.name|policy name} field with the resource name in + * Required. A new or updated {@link protos.google.cloud.binaryauthorization.v1.Policy|policy} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1.Policy.name|policy name} field with the resource name in * the request URL, in the format `projects/* /policy`. * @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.binaryauthorization.v1.Policy | Policy}. - * 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.binaryauthorization.v1.Policy|Policy}. + * 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/binauthz_management_service_v1.update_policy.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_UpdatePolicy_async @@ -553,27 +551,26 @@ export class BinauthzManagementServiceV1Client { return this.innerApiCalls.updatePolicy(request, options, callback); } /** - * Creates an {@link google.cloud.binaryauthorization.v1.Attestor|attestor}, and returns a copy of the new - * {@link google.cloud.binaryauthorization.v1.Attestor|attestor}. Returns NOT_FOUND if the project does not exist, + * Creates an {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}, and returns a copy of the new + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}. Returns NOT_FOUND if the project does not exist, * INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the - * {@link google.cloud.binaryauthorization.v1.Attestor|attestor} already exists. + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} already exists. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent of this {@link google.cloud.binaryauthorization.v1.Attestor|attestor}. + * Required. The parent of this {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}. * @param {string} request.attestorId - * Required. The {@link google.cloud.binaryauthorization.v1.Attestor|attestors} ID. + * Required. The {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors} ID. * @param {google.cloud.binaryauthorization.v1.Attestor} request.attestor - * Required. The initial {@link google.cloud.binaryauthorization.v1.Attestor|attestor} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1.Attestor.name|attestor name} field with the resource name, + * Required. The initial {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1.Attestor.name|attestor name} field with the resource name, * in the format `projects/* /attestors/*`. * @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.binaryauthorization.v1.Attestor | Attestor}. - * 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.binaryauthorization.v1.Attestor|Attestor}. + * 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/binauthz_management_service_v1.create_attestor.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_CreateAttestor_async @@ -659,20 +656,19 @@ export class BinauthzManagementServiceV1Client { return this.innerApiCalls.createAttestor(request, options, callback); } /** - * Gets an {@link google.cloud.binaryauthorization.v1.Attestor|attestor}. - * Returns NOT_FOUND if the {@link google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. + * Gets an {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}. + * Returns NOT_FOUND if the {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the {@link google.cloud.binaryauthorization.v1.Attestor|attestor} to retrieve, in the format + * Required. The name of the {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} to retrieve, in the format * `projects/* /attestors/*`. * @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.binaryauthorization.v1.Attestor | Attestor}. - * 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.binaryauthorization.v1.Attestor|Attestor}. + * 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/binauthz_management_service_v1.get_attestor.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_GetAttestor_async @@ -758,21 +754,20 @@ export class BinauthzManagementServiceV1Client { return this.innerApiCalls.getAttestor(request, options, callback); } /** - * Updates an {@link google.cloud.binaryauthorization.v1.Attestor|attestor}. - * Returns NOT_FOUND if the {@link google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. + * Updates an {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}. + * Returns NOT_FOUND if the {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.binaryauthorization.v1.Attestor} request.attestor - * Required. The updated {@link google.cloud.binaryauthorization.v1.Attestor|attestor} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1.Attestor.name|attestor name} field with the resource name + * Required. The updated {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1.Attestor.name|attestor name} field with the resource name * in the request URL, in the format `projects/* /attestors/*`. * @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.binaryauthorization.v1.Attestor | Attestor}. - * 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.binaryauthorization.v1.Attestor|Attestor}. + * 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/binauthz_management_service_v1.update_attestor.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_UpdateAttestor_async @@ -858,20 +853,19 @@ export class BinauthzManagementServiceV1Client { return this.innerApiCalls.updateAttestor(request, options, callback); } /** - * Deletes an {@link google.cloud.binaryauthorization.v1.Attestor|attestor}. Returns NOT_FOUND if the - * {@link google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. + * Deletes an {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor}. Returns NOT_FOUND if the + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the {@link google.cloud.binaryauthorization.v1.Attestor|attestors} to delete, in the format + * Required. The name of the {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors} to delete, in the format * `projects/* /attestors/*`. * @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/binauthz_management_service_v1.delete_attestor.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_DeleteAttestor_async @@ -958,32 +952,31 @@ export class BinauthzManagementServiceV1Client { } /** - * Lists {@link google.cloud.binaryauthorization.v1.Attestor|attestors}. + * Lists {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors}. * Returns INVALID_ARGUMENT if the project does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1.Attestor | Attestor}. + * The first element of the array is Array of {@link protos.google.cloud.binaryauthorization.v1.Attestor|Attestor}. * 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 `listAttestorsAsync()` * 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. */ listAttestors( @@ -1067,24 +1060,23 @@ export class BinauthzManagementServiceV1Client { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1.Attestor | Attestor} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.binaryauthorization.v1.Attestor|Attestor} 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 `listAttestorsAsync()` * 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. */ listAttestorsStream( @@ -1117,23 +1109,22 @@ export class BinauthzManagementServiceV1Client { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1.Attestor | Attestor}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.binaryauthorization.v1.Attestor|Attestor}. 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/binauthz_management_service_v1.list_attestors.js * region_tag:binaryauthorization_v1_generated_BinauthzManagementServiceV1_ListAttestors_async diff --git a/packages/google-cloud-binaryauthorization/src/v1/system_policy_v1_client.ts b/packages/google-cloud-binaryauthorization/src/v1/system_policy_v1_client.ts index cd5bdb8ec54..9f91a074d83 100644 --- a/packages/google-cloud-binaryauthorization/src/v1/system_policy_v1_client.ts +++ b/packages/google-cloud-binaryauthorization/src/v1/system_policy_v1_client.ts @@ -334,9 +334,8 @@ export class SystemPolicyV1Client { * @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.binaryauthorization.v1.Policy | Policy}. - * 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.binaryauthorization.v1.Policy|Policy}. + * 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/system_policy_v1.get_system_policy.js * region_tag:binaryauthorization_v1_generated_SystemPolicyV1_GetSystemPolicy_async diff --git a/packages/google-cloud-binaryauthorization/src/v1/validation_helper_v1_client.ts b/packages/google-cloud-binaryauthorization/src/v1/validation_helper_v1_client.ts index 1d466d66b4d..b0d668ac676 100644 --- a/packages/google-cloud-binaryauthorization/src/v1/validation_helper_v1_client.ts +++ b/packages/google-cloud-binaryauthorization/src/v1/validation_helper_v1_client.ts @@ -330,26 +330,25 @@ export class ValidationHelperV1Client { * @param {Object} request * The request object that will be sent. * @param {string} request.attestor - * Required. The resource name of the {@link google.cloud.binaryauthorization.v1.Attestor|Attestor} of the - * {@link grafeas.v1.Occurrence|occurrence}, in the format + * Required. The resource name of the {@link protos.google.cloud.binaryauthorization.v1.Attestor|Attestor} of the + * {@link protos.grafeas.v1.Occurrence|occurrence}, in the format * `projects/* /attestors/*`. * @param {grafeas.v1.AttestationOccurrence} request.attestation - * Required. An {@link grafeas.v1.AttestationOccurrence|AttestationOccurrence} to + * Required. An {@link protos.grafeas.v1.AttestationOccurrence|AttestationOccurrence} to * be checked that it can be verified by the Attestor. It does not have to be * an existing entity in Container Analysis. It must otherwise be a valid * AttestationOccurrence. * @param {string} request.occurrenceNote - * Required. The resource name of the {@link grafeas.v1.Note|Note} to which the - * containing {@link grafeas.v1.Occurrence|Occurrence} is associated. + * Required. The resource name of the {@link protos.grafeas.v1.Note|Note} to which the + * containing {@link protos.grafeas.v1.Occurrence|Occurrence} is associated. * @param {string} request.occurrenceResourceUri * Required. The URI of the artifact (e.g. container image) that is the - * subject of the containing {@link grafeas.v1.Occurrence|Occurrence}. + * subject of the containing {@link protos.grafeas.v1.Occurrence|Occurrence}. * @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.binaryauthorization.v1.ValidateAttestationOccurrenceResponse | ValidateAttestationOccurrenceResponse}. - * 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.binaryauthorization.v1.ValidateAttestationOccurrenceResponse|ValidateAttestationOccurrenceResponse}. + * 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/validation_helper_v1.validate_attestation_occurrence.js * region_tag:binaryauthorization_v1_generated_ValidationHelperV1_ValidateAttestationOccurrence_async diff --git a/packages/google-cloud-binaryauthorization/src/v1beta1/binauthz_management_service_v1_beta1_client.ts b/packages/google-cloud-binaryauthorization/src/v1beta1/binauthz_management_service_v1_beta1_client.ts index ac5e16d5b98..2e7705664b9 100644 --- a/packages/google-cloud-binaryauthorization/src/v1beta1/binauthz_management_service_v1_beta1_client.ts +++ b/packages/google-cloud-binaryauthorization/src/v1beta1/binauthz_management_service_v1_beta1_client.ts @@ -43,8 +43,8 @@ const version = require('../../../package.json').version; * * This API implements a REST model with the following objects: * - * * {@link google.cloud.binaryauthorization.v1beta1.Policy|Policy} - * * {@link google.cloud.binaryauthorization.v1beta1.Attestor|Attestor} + * * {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|Policy} + * * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|Attestor} * @class * @memberof v1beta1 */ @@ -352,25 +352,24 @@ export class BinauthzManagementServiceV1Beta1Client { // -- Service calls -- // ------------------- /** - * A {@link google.cloud.binaryauthorization.v1beta1.Policy|policy} specifies the {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors} that must attest to + * A {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy} specifies the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors} that must attest to * a container image, before the project is allowed to deploy that * image. There is at most one policy per project. All image admission * requests are permitted if a project has no policy. * - * Gets the {@link google.cloud.binaryauthorization.v1beta1.Policy|policy} for this project. Returns a default - * {@link google.cloud.binaryauthorization.v1beta1.Policy|policy} if the project does not have one. + * Gets the {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy} for this project. Returns a default + * {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy} if the project does not have one. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The resource name of the {@link google.cloud.binaryauthorization.v1beta1.Policy|policy} to retrieve, + * Required. The resource name of the {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy} to retrieve, * in the format `projects/* /policy`. * @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.binaryauthorization.v1beta1.Policy | Policy}. - * 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.binaryauthorization.v1beta1.Policy|Policy}. + * 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/binauthz_management_service_v1_beta1.get_policy.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_GetPolicy_async @@ -456,8 +455,8 @@ export class BinauthzManagementServiceV1Beta1Client { return this.innerApiCalls.getPolicy(request, options, callback); } /** - * Creates or updates a project's {@link google.cloud.binaryauthorization.v1beta1.Policy|policy}, and returns a copy of the - * new {@link google.cloud.binaryauthorization.v1beta1.Policy|policy}. A policy is always updated as a whole, to avoid race + * Creates or updates a project's {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy}, and returns a copy of the + * new {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy}. A policy is always updated as a whole, to avoid race * conditions with concurrent policy enforcement (or management!) * requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT * if the request is malformed. @@ -465,15 +464,14 @@ export class BinauthzManagementServiceV1Beta1Client { * @param {Object} request * The request object that will be sent. * @param {google.cloud.binaryauthorization.v1beta1.Policy} request.policy - * Required. A new or updated {@link google.cloud.binaryauthorization.v1beta1.Policy|policy} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1beta1.Policy.name|policy name} field with the resource name in + * Required. A new or updated {@link protos.google.cloud.binaryauthorization.v1beta1.Policy|policy} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1beta1.Policy.name|policy name} field with the resource name in * the request URL, in the format `projects/* /policy`. * @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.binaryauthorization.v1beta1.Policy | Policy}. - * 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.binaryauthorization.v1beta1.Policy|Policy}. + * 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/binauthz_management_service_v1_beta1.update_policy.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_UpdatePolicy_async @@ -559,27 +557,26 @@ export class BinauthzManagementServiceV1Beta1Client { return this.innerApiCalls.updatePolicy(request, options, callback); } /** - * Creates an {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}, and returns a copy of the new - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. Returns NOT_FOUND if the project does not exist, + * Creates an {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}, and returns a copy of the new + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. Returns NOT_FOUND if the project does not exist, * INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} already exists. + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} already exists. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. The parent of this {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. + * Required. The parent of this {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. * @param {string} request.attestorId - * Required. The {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors} ID. + * Required. The {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors} ID. * @param {google.cloud.binaryauthorization.v1beta1.Attestor} request.attestor - * Required. The initial {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1beta1.Attestor.name|attestor name} field with the resource name, + * Required. The initial {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor.name|attestor name} field with the resource name, * in the format `projects/* /attestors/*`. * @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.binaryauthorization.v1beta1.Attestor | Attestor}. - * 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.binaryauthorization.v1beta1.Attestor|Attestor}. + * 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/binauthz_management_service_v1_beta1.create_attestor.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_CreateAttestor_async @@ -665,20 +662,19 @@ export class BinauthzManagementServiceV1Beta1Client { return this.innerApiCalls.createAttestor(request, options, callback); } /** - * Gets an {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. - * Returns NOT_FOUND if the {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. + * Gets an {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. + * Returns NOT_FOUND if the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} to retrieve, in the format + * Required. The name of the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} to retrieve, in the format * `projects/* /attestors/*`. * @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.binaryauthorization.v1beta1.Attestor | Attestor}. - * 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.binaryauthorization.v1beta1.Attestor|Attestor}. + * 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/binauthz_management_service_v1_beta1.get_attestor.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_GetAttestor_async @@ -764,21 +760,20 @@ export class BinauthzManagementServiceV1Beta1Client { return this.innerApiCalls.getAttestor(request, options, callback); } /** - * Updates an {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. - * Returns NOT_FOUND if the {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. + * Updates an {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. + * Returns NOT_FOUND if the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.binaryauthorization.v1beta1.Attestor} request.attestor - * Required. The updated {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} value. The service will - * overwrite the {@link google.cloud.binaryauthorization.v1beta1.Attestor.name|attestor name} field with the resource name + * Required. The updated {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} value. The service will + * overwrite the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor.name|attestor name} field with the resource name * in the request URL, in the format `projects/* /attestors/*`. * @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.binaryauthorization.v1beta1.Attestor | Attestor}. - * 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.binaryauthorization.v1beta1.Attestor|Attestor}. + * 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/binauthz_management_service_v1_beta1.update_attestor.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_UpdateAttestor_async @@ -864,20 +859,19 @@ export class BinauthzManagementServiceV1Beta1Client { return this.innerApiCalls.updateAttestor(request, options, callback); } /** - * Deletes an {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. Returns NOT_FOUND if the - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. + * Deletes an {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor}. Returns NOT_FOUND if the + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestor} does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.name - * Required. The name of the {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors} to delete, in the format + * Required. The name of the {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors} to delete, in the format * `projects/* /attestors/*`. * @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/binauthz_management_service_v1_beta1.delete_attestor.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_DeleteAttestor_async @@ -964,32 +958,31 @@ export class BinauthzManagementServiceV1Beta1Client { } /** - * Lists {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors}. + * Lists {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors}. * Returns INVALID_ARGUMENT if the project does not exist. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1beta1.Attestor | Attestor}. + * The first element of the array is Array of {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|Attestor}. * 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 `listAttestorsAsync()` * 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. */ listAttestors( @@ -1073,24 +1066,23 @@ export class BinauthzManagementServiceV1Beta1Client { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1beta1.Attestor | Attestor} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|Attestor} 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 `listAttestorsAsync()` * 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. */ listAttestorsStream( @@ -1123,23 +1115,22 @@ export class BinauthzManagementServiceV1Beta1Client { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the project associated with the - * {@link google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|attestors}, in the format `projects/*`. * @param {number} request.pageSize * Requested page size. The server may return fewer results than requested. If * unspecified, the server will pick an appropriate default. * @param {string} request.pageToken * A token identifying a page of results the server should return. Typically, - * this is the value of {@link google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned + * this is the value of {@link protos.google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token|ListAttestorsResponse.next_page_token} returned * from the previous call to the `ListAttestors` method. * @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.binaryauthorization.v1beta1.Attestor | Attestor}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.binaryauthorization.v1beta1.Attestor|Attestor}. 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/binauthz_management_service_v1_beta1.list_attestors.js * region_tag:binaryauthorization_v1beta1_generated_BinauthzManagementServiceV1Beta1_ListAttestors_async diff --git a/packages/google-cloud-binaryauthorization/src/v1beta1/system_policy_v1_beta1_client.ts b/packages/google-cloud-binaryauthorization/src/v1beta1/system_policy_v1_beta1_client.ts index 04817a46f94..97266e9ec52 100644 --- a/packages/google-cloud-binaryauthorization/src/v1beta1/system_policy_v1_beta1_client.ts +++ b/packages/google-cloud-binaryauthorization/src/v1beta1/system_policy_v1_beta1_client.ts @@ -334,9 +334,8 @@ export class SystemPolicyV1Beta1Client { * @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.binaryauthorization.v1beta1.Policy | Policy}. - * 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.binaryauthorization.v1beta1.Policy|Policy}. + * 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/system_policy_v1_beta1.get_system_policy.js * region_tag:binaryauthorization_v1beta1_generated_SystemPolicyV1Beta1_GetSystemPolicy_async diff --git a/packages/google-cloud-certificatemanager/README.md b/packages/google-cloud-certificatemanager/README.md index 33622606fa3..b736e7081ea 100644 --- a/packages/google-cloud-certificatemanager/README.md +++ b/packages/google-cloud-certificatemanager/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Certificate Manager: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Certificate Manager: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-certificatemanager) [![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/certificate-manager.svg)](https://www.npmjs.org/package/@google-cloud/certificate-manager) @@ -116,36 +116,35 @@ callListCertificates(); ## 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-certificatemanager/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Certificate_manager.create_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate.js,samples/README.md) | -| Certificate_manager.create_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_issuance_config.js,samples/README.md) | -| Certificate_manager.create_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map.js,samples/README.md) | -| Certificate_manager.create_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map_entry.js,samples/README.md) | -| Certificate_manager.create_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_dns_authorization.js,samples/README.md) | -| Certificate_manager.delete_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate.js,samples/README.md) | -| Certificate_manager.delete_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_issuance_config.js,samples/README.md) | -| Certificate_manager.delete_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map.js,samples/README.md) | -| Certificate_manager.delete_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map_entry.js,samples/README.md) | -| Certificate_manager.delete_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_dns_authorization.js,samples/README.md) | -| Certificate_manager.get_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate.js,samples/README.md) | -| Certificate_manager.get_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_issuance_config.js,samples/README.md) | -| Certificate_manager.get_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map.js,samples/README.md) | -| Certificate_manager.get_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map_entry.js,samples/README.md) | -| Certificate_manager.get_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_dns_authorization.js,samples/README.md) | -| Certificate_manager.list_certificate_issuance_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_issuance_configs.js,samples/README.md) | -| Certificate_manager.list_certificate_map_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_map_entries.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_map_entries.js,samples/README.md) | -| Certificate_manager.list_certificate_maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_maps.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_maps.js,samples/README.md) | -| Certificate_manager.list_certificates | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificates.js,samples/README.md) | -| Certificate_manager.list_dns_authorizations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_dns_authorizations.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_dns_authorizations.js,samples/README.md) | -| Certificate_manager.update_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate.js,samples/README.md) | -| Certificate_manager.update_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map.js,samples/README.md) | -| Certificate_manager.update_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map_entry.js,samples/README.md) | -| Certificate_manager.update_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_dns_authorization.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/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-certificatemanager/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/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-certificatemanager/samples/test/quickstart.js,samples/README.md) | +| Certificate_manager.create_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.create_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_issuance_config.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.create_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.create_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_certificate_map_entry.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.create_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.create_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.create_dns_authorization.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.delete_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.delete_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_issuance_config.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.delete_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.delete_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_certificate_map_entry.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.delete_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.delete_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.delete_dns_authorization.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.get_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.get_certificate_issuance_config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_issuance_config.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.get_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.get_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_certificate_map_entry.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.get_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.get_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.get_dns_authorization.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.list_certificate_issuance_configs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_issuance_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_issuance_configs.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.list_certificate_map_entries | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_map_entries.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_map_entries.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.list_certificate_maps | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_maps.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_certificate_maps.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.list_certificates | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_certificates.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.list_dns_authorizations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.list_dns_authorizations.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.list_dns_authorizations.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.update_certificate | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_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-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.update_certificate_map | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.update_certificate_map_entry | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map_entry.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_certificate_map_entry.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Certificate_manager.update_dns_authorization | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/samples/generated/v1/certificate_manager.update_dns_authorization.js) | [![Open in Cloud Shell][shell_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-certificatemanager/samples/generated/v1/certificate_manager.update_dns_authorization.js,packages/google-cloud-certificatemanager/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/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-certificatemanager/samples/quickstart.js,packages/google-cloud-certificatemanager/samples/README.md) | diff --git a/packages/google-cloud-certificatemanager/package.json b/packages/google-cloud-certificatemanager/package.json index 0b8ece52bef..b2d0c16e96e 100644 --- a/packages/google-cloud-certificatemanager/package.json +++ b/packages/google-cloud-certificatemanager/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.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", @@ -64,11 +65,11 @@ "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" } } diff --git a/packages/google-cloud-certificatemanager/samples/README.md b/packages/google-cloud-certificatemanager/samples/README.md index a5c5f565e03..c9a191de009 100644 --- a/packages/google-cloud-certificatemanager/samples/README.md +++ b/packages/google-cloud-certificatemanager/samples/README.md @@ -37,7 +37,6 @@ * [Certificate_manager.update_certificate_map_entry](#certificate_manager.update_certificate_map_entry) * [Certificate_manager.update_dns_authorization](#certificate_manager.update_dns_authorization) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -474,23 +473,6 @@ __Usage:__ `node packages/google-cloud-certificatemanager/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-certificatemanager/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-certificatemanager/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-certificatemanager/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata.google.cloud.certificatemanager.v1.json b/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata.google.cloud.certificatemanager.v1.json index bddfa44d927..19f35113b41 100644 --- a/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata.google.cloud.certificatemanager.v1.json +++ b/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata.google.cloud.certificatemanager.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-certificatemanager", - "version": "0.7.1", + "version": "0.7.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata_google.cloud.certificatemanager.v1.json b/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata_google.cloud.certificatemanager.v1.json new file mode 100644 index 00000000000..19f35113b41 --- /dev/null +++ b/packages/google-cloud-certificatemanager/samples/generated/v1/snippet_metadata_google.cloud.certificatemanager.v1.json @@ -0,0 +1,1111 @@ +{ + "clientLibrary": { + "name": "nodejs-certificatemanager", + "version": "0.7.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.certificatemanager.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_ListCertificates_async", + "title": "CertificateManager listCertificates Sample", + "origin": "API_DEFINITION", + "description": " Lists Certificates in a given project and location.", + "canonical": true, + "file": "certificate_manager.list_certificates.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCertificates", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificates", + "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.certificatemanager.v1.ListCertificatesResponse", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "ListCertificates", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificates", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_GetCertificate_async", + "title": "CertificateManager getCertificate Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Certificate.", + "canonical": true, + "file": "certificate_manager.get_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.certificatemanager.v1.Certificate", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "GetCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificate", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_CreateCertificate_async", + "title": "CertificateManager createCertificate Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Certificate in a given project and location.", + "canonical": true, + "file": "certificate_manager.create_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "certificate_id", + "type": "TYPE_STRING" + }, + { + "name": "certificate", + "type": ".google.cloud.certificatemanager.v1.Certificate" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "CreateCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificate", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_UpdateCertificate_async", + "title": "CertificateManager updateCertificate Sample", + "origin": "API_DEFINITION", + "description": " Updates a Certificate.", + "canonical": true, + "file": "certificate_manager.update_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificate", + "async": true, + "parameters": [ + { + "name": "certificate", + "type": ".google.cloud.certificatemanager.v1.Certificate" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "UpdateCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificate", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_DeleteCertificate_async", + "title": "CertificateManager deleteCertificate Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Certificate.", + "canonical": true, + "file": "certificate_manager.delete_certificate.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "DeleteCertificate", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificate", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_ListCertificateMaps_async", + "title": "CertificateManager listCertificateMaps Sample", + "origin": "API_DEFINITION", + "description": " Lists CertificateMaps in a given project and location.", + "canonical": true, + "file": "certificate_manager.list_certificate_maps.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCertificateMaps", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateMaps", + "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.certificatemanager.v1.ListCertificateMapsResponse", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "ListCertificateMaps", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateMaps", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_GetCertificateMap_async", + "title": "CertificateManager getCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single CertificateMap.", + "canonical": true, + "file": "certificate_manager.get_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateMap", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.certificatemanager.v1.CertificateMap", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "GetCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateMap", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_CreateCertificateMap_async", + "title": "CertificateManager createCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Creates a new CertificateMap in a given project and location.", + "canonical": true, + "file": "certificate_manager.create_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateMap", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "certificate_map_id", + "type": "TYPE_STRING" + }, + { + "name": "certificate_map", + "type": ".google.cloud.certificatemanager.v1.CertificateMap" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "CreateCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateMap", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_UpdateCertificateMap_async", + "title": "CertificateManager updateCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Updates a CertificateMap.", + "canonical": true, + "file": "certificate_manager.update_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificateMap", + "async": true, + "parameters": [ + { + "name": "certificate_map", + "type": ".google.cloud.certificatemanager.v1.CertificateMap" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "UpdateCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificateMap", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_DeleteCertificateMap_async", + "title": "CertificateManager deleteCertificateMap Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.", + "canonical": true, + "file": "certificate_manager.delete_certificate_map.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateMap", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "DeleteCertificateMap", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateMap", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_ListCertificateMapEntries_async", + "title": "CertificateManager listCertificateMapEntries Sample", + "origin": "API_DEFINITION", + "description": " Lists CertificateMapEntries in a given project and location.", + "canonical": true, + "file": "certificate_manager.list_certificate_map_entries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCertificateMapEntries", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateMapEntries", + "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.certificatemanager.v1.ListCertificateMapEntriesResponse", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "ListCertificateMapEntries", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateMapEntries", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_GetCertificateMapEntry_async", + "title": "CertificateManager getCertificateMapEntry Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single CertificateMapEntry.", + "canonical": true, + "file": "certificate_manager.get_certificate_map_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateMapEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.certificatemanager.v1.CertificateMapEntry", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "GetCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateMapEntry", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_CreateCertificateMapEntry_async", + "title": "CertificateManager createCertificateMapEntry Sample", + "origin": "API_DEFINITION", + "description": " Creates a new CertificateMapEntry in a given project and location.", + "canonical": true, + "file": "certificate_manager.create_certificate_map_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateMapEntry", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "certificate_map_entry_id", + "type": "TYPE_STRING" + }, + { + "name": "certificate_map_entry", + "type": ".google.cloud.certificatemanager.v1.CertificateMapEntry" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "CreateCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateMapEntry", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_UpdateCertificateMapEntry_async", + "title": "CertificateManager updateCertificateMapEntry Sample", + "origin": "API_DEFINITION", + "description": " Updates a CertificateMapEntry.", + "canonical": true, + "file": "certificate_manager.update_certificate_map_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificateMapEntry", + "async": true, + "parameters": [ + { + "name": "certificate_map_entry", + "type": ".google.cloud.certificatemanager.v1.CertificateMapEntry" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "UpdateCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateCertificateMapEntry", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_DeleteCertificateMapEntry_async", + "title": "CertificateManager deleteCertificateMapEntry Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single CertificateMapEntry.", + "canonical": true, + "file": "certificate_manager.delete_certificate_map_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateMapEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "DeleteCertificateMapEntry", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateMapEntry", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_ListDnsAuthorizations_async", + "title": "CertificateManager listDnsAuthorizations Sample", + "origin": "API_DEFINITION", + "description": " Lists DnsAuthorizations in a given project and location.", + "canonical": true, + "file": "certificate_manager.list_dns_authorizations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDnsAuthorizations", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListDnsAuthorizations", + "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.certificatemanager.v1.ListDnsAuthorizationsResponse", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "ListDnsAuthorizations", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListDnsAuthorizations", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_GetDnsAuthorization_async", + "title": "CertificateManager getDnsAuthorization Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single DnsAuthorization.", + "canonical": true, + "file": "certificate_manager.get_dns_authorization.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetDnsAuthorization", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.certificatemanager.v1.DnsAuthorization", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "GetDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetDnsAuthorization", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_CreateDnsAuthorization_async", + "title": "CertificateManager createDnsAuthorization Sample", + "origin": "API_DEFINITION", + "description": " Creates a new DnsAuthorization in a given project and location.", + "canonical": true, + "file": "certificate_manager.create_dns_authorization.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateDnsAuthorization", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dns_authorization_id", + "type": "TYPE_STRING" + }, + { + "name": "dns_authorization", + "type": ".google.cloud.certificatemanager.v1.DnsAuthorization" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "CreateDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateDnsAuthorization", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_UpdateDnsAuthorization_async", + "title": "CertificateManager updateDnsAuthorization Sample", + "origin": "API_DEFINITION", + "description": " Updates a DnsAuthorization.", + "canonical": true, + "file": "certificate_manager.update_dns_authorization.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateDnsAuthorization", + "async": true, + "parameters": [ + { + "name": "dns_authorization", + "type": ".google.cloud.certificatemanager.v1.DnsAuthorization" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "UpdateDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.UpdateDnsAuthorization", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_DeleteDnsAuthorization_async", + "title": "CertificateManager deleteDnsAuthorization Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single DnsAuthorization.", + "canonical": true, + "file": "certificate_manager.delete_dns_authorization.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteDnsAuthorization", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "DeleteDnsAuthorization", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteDnsAuthorization", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_ListCertificateIssuanceConfigs_async", + "title": "CertificateManager listCertificateIssuanceConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists CertificateIssuanceConfigs in a given project and location.", + "canonical": true, + "file": "certificate_manager.list_certificate_issuance_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCertificateIssuanceConfigs", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateIssuanceConfigs", + "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.certificatemanager.v1.ListCertificateIssuanceConfigsResponse", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "ListCertificateIssuanceConfigs", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.ListCertificateIssuanceConfigs", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_GetCertificateIssuanceConfig_async", + "title": "CertificateManager getCertificateIssuanceConfig Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single CertificateIssuanceConfig.", + "canonical": true, + "file": "certificate_manager.get_certificate_issuance_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateIssuanceConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.certificatemanager.v1.CertificateIssuanceConfig", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "GetCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.GetCertificateIssuanceConfig", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_CreateCertificateIssuanceConfig_async", + "title": "CertificateManager createCertificateIssuanceConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a new CertificateIssuanceConfig in a given project and location.", + "canonical": true, + "file": "certificate_manager.create_certificate_issuance_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateIssuanceConfig", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "certificate_issuance_config_id", + "type": "TYPE_STRING" + }, + { + "name": "certificate_issuance_config", + "type": ".google.cloud.certificatemanager.v1.CertificateIssuanceConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "CreateCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.CreateCertificateIssuanceConfig", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + }, + { + "regionTag": "certificatemanager_v1_generated_CertificateManager_DeleteCertificateIssuanceConfig_async", + "title": "CertificateManager deleteCertificateIssuanceConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single CertificateIssuanceConfig.", + "canonical": true, + "file": "certificate_manager.delete_certificate_issuance_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateIssuanceConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CertificateManagerClient", + "fullName": "google.cloud.certificatemanager.v1.CertificateManagerClient" + }, + "method": { + "shortName": "DeleteCertificateIssuanceConfig", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager.DeleteCertificateIssuanceConfig", + "service": { + "shortName": "CertificateManager", + "fullName": "google.cloud.certificatemanager.v1.CertificateManager" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-certificatemanager/samples/package.json b/packages/google-cloud-certificatemanager/samples/package.json index 0d9f1f0b76d..74808d8d7c4 100644 --- a/packages/google-cloud-certificatemanager/samples/package.json +++ b/packages/google-cloud-certificatemanager/samples/package.json @@ -8,7 +8,7 @@ "author": "Google LLC", "repository": "googleapis/nodejs-secret-manager", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "scripts": { "test": "c8 mocha --recursive test/ --timeout=800000" @@ -22,4 +22,4 @@ "mocha": "^9.0.0", "uuid": "^9.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts b/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts index acc6dc4b3a3..38bff62f4b0 100644 --- a/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts +++ b/packages/google-cloud-certificatemanager/src/v1/certificate_manager_client.ts @@ -669,9 +669,8 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.Certificate | Certificate}. - * 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.certificatemanager.v1.Certificate|Certificate}. + * 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/certificate_manager.get_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_GetCertificate_async @@ -767,9 +766,8 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMap | CertificateMap}. - * 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.certificatemanager.v1.CertificateMap|CertificateMap}. + * 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/certificate_manager.get_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_GetCertificateMap_async @@ -865,9 +863,8 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMapEntry | CertificateMapEntry}. - * 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.certificatemanager.v1.CertificateMapEntry|CertificateMapEntry}. + * 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/certificate_manager.get_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_GetCertificateMapEntry_async @@ -967,9 +964,8 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.DnsAuthorization | DnsAuthorization}. - * 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.certificatemanager.v1.DnsAuthorization|DnsAuthorization}. + * 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/certificate_manager.get_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_GetDnsAuthorization_async @@ -1065,9 +1061,8 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateIssuanceConfig | CertificateIssuanceConfig}. - * 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.certificatemanager.v1.CertificateIssuanceConfig|CertificateIssuanceConfig}. + * 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/certificate_manager.get_certificate_issuance_config.js * region_tag:certificatemanager_v1_generated_CertificateManager_GetCertificateIssuanceConfig_async @@ -1175,8 +1170,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificate_async @@ -1271,8 +1265,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificate_async @@ -1317,8 +1310,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificate_async @@ -1413,8 +1405,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificate_async @@ -1456,8 +1447,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificate_async @@ -1552,8 +1542,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificate_async @@ -1599,8 +1588,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateMap_async @@ -1695,8 +1683,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateMap_async @@ -1741,8 +1728,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificateMap_async @@ -1837,8 +1823,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificateMap_async @@ -1882,8 +1867,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateMap_async @@ -1978,8 +1962,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_map.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateMap_async @@ -2025,8 +2008,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateMapEntry_async @@ -2125,8 +2107,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateMapEntry_async @@ -2171,8 +2152,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificateMapEntry_async @@ -2271,8 +2251,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateCertificateMapEntry_async @@ -2314,8 +2293,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateMapEntry_async @@ -2414,8 +2392,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_map_entry.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateMapEntry_async @@ -2461,8 +2438,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateDnsAuthorization_async @@ -2561,8 +2537,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateDnsAuthorization_async @@ -2607,8 +2582,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateDnsAuthorization_async @@ -2707,8 +2681,7 @@ export class CertificateManagerClient { * 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/certificate_manager.update_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_UpdateDnsAuthorization_async @@ -2750,8 +2723,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteDnsAuthorization_async @@ -2850,8 +2822,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_dns_authorization.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteDnsAuthorization_async @@ -2897,8 +2868,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_issuance_config.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateIssuanceConfig_async @@ -2997,8 +2967,7 @@ export class CertificateManagerClient { * 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/certificate_manager.create_certificate_issuance_config.js * region_tag:certificatemanager_v1_generated_CertificateManager_CreateCertificateIssuanceConfig_async @@ -3040,8 +3009,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_issuance_config.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateIssuanceConfig_async @@ -3140,8 +3108,7 @@ export class CertificateManagerClient { * 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/certificate_manager.delete_certificate_issuance_config.js * region_tag:certificatemanager_v1_generated_CertificateManager_DeleteCertificateIssuanceConfig_async @@ -3192,14 +3159,13 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.Certificate | Certificate}. + * The first element of the array is Array of {@link protos.google.cloud.certificatemanager.v1.Certificate|Certificate}. * 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 `listCertificatesAsync()` * 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. */ listCertificates( @@ -3299,13 +3265,12 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.Certificate | Certificate} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.certificatemanager.v1.Certificate|Certificate} 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 `listCertificatesAsync()` * 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. */ listCertificatesStream( @@ -3354,12 +3319,11 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.Certificate | Certificate}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.certificatemanager.v1.Certificate|Certificate}. 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/certificate_manager.list_certificates.js * region_tag:certificatemanager_v1_generated_CertificateManager_ListCertificates_async @@ -3408,14 +3372,13 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMap | CertificateMap}. + * The first element of the array is Array of {@link protos.google.cloud.certificatemanager.v1.CertificateMap|CertificateMap}. * 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 `listCertificateMapsAsync()` * 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. */ listCertificateMaps( @@ -3515,13 +3478,12 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMap | CertificateMap} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.certificatemanager.v1.CertificateMap|CertificateMap} 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 `listCertificateMapsAsync()` * 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. */ listCertificateMapsStream( @@ -3570,12 +3532,11 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMap | CertificateMap}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.certificatemanager.v1.CertificateMap|CertificateMap}. 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/certificate_manager.list_certificate_maps.js * region_tag:certificatemanager_v1_generated_CertificateManager_ListCertificateMaps_async @@ -3629,14 +3590,13 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMapEntry | CertificateMapEntry}. + * The first element of the array is Array of {@link protos.google.cloud.certificatemanager.v1.CertificateMapEntry|CertificateMapEntry}. * 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 `listCertificateMapEntriesAsync()` * 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. */ listCertificateMapEntries( @@ -3745,13 +3705,12 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMapEntry | CertificateMapEntry} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.certificatemanager.v1.CertificateMapEntry|CertificateMapEntry} 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 `listCertificateMapEntriesAsync()` * 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. */ listCertificateMapEntriesStream( @@ -3805,12 +3764,11 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateMapEntry | CertificateMapEntry}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.certificatemanager.v1.CertificateMapEntry|CertificateMapEntry}. 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/certificate_manager.list_certificate_map_entries.js * region_tag:certificatemanager_v1_generated_CertificateManager_ListCertificateMapEntries_async @@ -3859,14 +3817,13 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.DnsAuthorization | DnsAuthorization}. + * The first element of the array is Array of {@link protos.google.cloud.certificatemanager.v1.DnsAuthorization|DnsAuthorization}. * 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 `listDnsAuthorizationsAsync()` * 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. */ listDnsAuthorizations( @@ -3966,13 +3923,12 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.DnsAuthorization | DnsAuthorization} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.certificatemanager.v1.DnsAuthorization|DnsAuthorization} 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 `listDnsAuthorizationsAsync()` * 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. */ listDnsAuthorizationsStream( @@ -4021,12 +3977,11 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.DnsAuthorization | DnsAuthorization}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.certificatemanager.v1.DnsAuthorization|DnsAuthorization}. 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/certificate_manager.list_dns_authorizations.js * region_tag:certificatemanager_v1_generated_CertificateManager_ListDnsAuthorizations_async @@ -4076,14 +4031,13 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateIssuanceConfig | CertificateIssuanceConfig}. + * The first element of the array is Array of {@link protos.google.cloud.certificatemanager.v1.CertificateIssuanceConfig|CertificateIssuanceConfig}. * 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 `listCertificateIssuanceConfigsAsync()` * 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. */ listCertificateIssuanceConfigs( @@ -4188,13 +4142,12 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateIssuanceConfig | CertificateIssuanceConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.certificatemanager.v1.CertificateIssuanceConfig|CertificateIssuanceConfig} 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 `listCertificateIssuanceConfigsAsync()` * 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. */ listCertificateIssuanceConfigsStream( @@ -4245,12 +4198,11 @@ export class CertificateManagerClient { * @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.certificatemanager.v1.CertificateIssuanceConfig | CertificateIssuanceConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.certificatemanager.v1.CertificateIssuanceConfig|CertificateIssuanceConfig}. 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/certificate_manager.list_certificate_issuance_configs.js * region_tag:certificatemanager_v1_generated_CertificateManager_ListCertificateIssuanceConfigs_async @@ -4288,8 +4240,7 @@ export class CertificateManagerClient { * 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 * ``` @@ -4335,12 +4286,11 @@ export class CertificateManagerClient { * @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-channel/package.json b/packages/google-cloud-channel/package.json index 2b48daa1b54..60440d89a08 100644 --- a/packages/google-cloud-channel/package.json +++ b/packages/google-cloud-channel/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-channel" } diff --git a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_reports_service.fetch_report_results.js b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_reports_service.fetch_report_results.js index b952e2d7390..92b6e24ed7d 100644 --- a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_reports_service.fetch_report_results.js +++ b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_reports_service.fetch_report_results.js @@ -56,7 +56,7 @@ function main(reportJob) { * Optional. List of keys specifying which report partitions to return. * If empty, returns all partitions. */ - // const partitionKeys = 'abc123' + // const partitionKeys = ['abc','def'] // Imports the Channel library const {CloudChannelReportsServiceClient} = require('@google-cloud/channel').v1; diff --git a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_offer.js b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_offer.js index f610f3dd3f8..04242d5dcda 100644 --- a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_offer.js +++ b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_offer.js @@ -45,7 +45,7 @@ function main(name, offer) { * Offer.parameter_definitions google.cloud.channel.v1.Offer.parameter_definitions * from the desired offer. */ - // const parameters = 1234 + // const parameters = [1,2,3,4] /** * Optional. Purchase order id provided by the reseller. */ diff --git a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_parameters.js b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_parameters.js index a38e5aed059..518594e8718 100644 --- a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_parameters.js +++ b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.change_parameters.js @@ -41,7 +41,7 @@ function main(name, parameters) { * Offer.parameter_definitions google.cloud.channel.v1.Offer.parameter_definitions * from the desired offer. */ - // const parameters = 1234 + // const parameters = [1,2,3,4] /** * Optional. You can specify an optional unique request ID, and if you need to * retry your request, the server will know to ignore the request if it's diff --git a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements.js b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements.js index 092408b4613..b33581c7089 100644 --- a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements.js +++ b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements.js @@ -37,7 +37,7 @@ function main(parent, entitlements) { /** * Required. The new entitlements to create or transfer. */ - // const entitlements = 1234 + // const entitlements = [1,2,3,4] /** * The super admin of the resold customer generates this token to * authorize a reseller to access their Cloud Identity and purchase diff --git a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements_to_google.js b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements_to_google.js index e67598fe91f..f6f0063e073 100644 --- a/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements_to_google.js +++ b/packages/google-cloud-channel/samples/generated/v1/cloud_channel_service.transfer_entitlements_to_google.js @@ -37,7 +37,7 @@ function main(parent, entitlements) { /** * Required. The entitlements to transfer to Google. */ - // const entitlements = 1234 + // const entitlements = [1,2,3,4] /** * Optional. You can specify an optional unique request ID, and if you need to * retry your request, the server will know to ignore the request if it's diff --git a/packages/google-cloud-channel/samples/generated/v1/snippet_metadata_google.cloud.channel.v1.json b/packages/google-cloud-channel/samples/generated/v1/snippet_metadata_google.cloud.channel.v1.json new file mode 100644 index 00000000000..e84ce0e9b89 --- /dev/null +++ b/packages/google-cloud-channel/samples/generated/v1/snippet_metadata_google.cloud.channel.v1.json @@ -0,0 +1,2479 @@ +{ + "clientLibrary": { + "name": "nodejs-channel", + "version": "2.8.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.channel.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "cloudchannel_v1_generated_CloudChannelReportsService_RunReportJob_async", + "title": "CloudChannelReportsService runReportJob Sample", + "origin": "API_DEFINITION", + "description": " Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`). Possible error codes: * PERMISSION_DENIED: The user doesn't have access to this report. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The report identifier was not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata]. To get the results of report generation, call [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].", + "canonical": true, + "file": "cloud_channel_reports_service.run_report_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RunReportJob", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.RunReportJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "date_range", + "type": ".google.cloud.channel.v1.DateRange" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelReportsServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelReportsServiceClient" + }, + "method": { + "shortName": "RunReportJob", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.RunReportJob", + "service": { + "shortName": "CloudChannelReportsService", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelReportsService_FetchReportResults_async", + "title": "CloudChannelReportsService fetchReportResults Sample", + "origin": "API_DEFINITION", + "description": " Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].", + "canonical": true, + "file": "cloud_channel_reports_service.fetch_report_results.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchReportResults", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults", + "async": true, + "parameters": [ + { + "name": "report_job", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "partition_keys", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.cloud.channel.v1.FetchReportResultsResponse", + "client": { + "shortName": "CloudChannelReportsServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelReportsServiceClient" + }, + "method": { + "shortName": "FetchReportResults", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults", + "service": { + "shortName": "CloudChannelReportsService", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelReportsService_ListReports_async", + "title": "CloudChannelReportsService listReports Sample", + "origin": "API_DEFINITION", + "description": " Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.", + "canonical": true, + "file": "cloud_channel_reports_service.list_reports.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListReports", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.ListReports", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListReportsResponse", + "client": { + "shortName": "CloudChannelReportsServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelReportsServiceClient" + }, + "method": { + "shortName": "ListReports", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService.ListReports", + "service": { + "shortName": "CloudChannelReportsService", + "fullName": "google.cloud.channel.v1.CloudChannelReportsService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListCustomers_async", + "title": "CloudChannelReportsService listCustomers Sample", + "origin": "API_DEFINITION", + "description": " List [Customer][google.cloud.channel.v1.Customer]s. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.", + "canonical": true, + "file": "cloud_channel_service.list_customers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListCustomers", + "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.channel.v1.ListCustomersResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListCustomers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListCustomers", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_GetCustomer_async", + "title": "CloudChannelReportsService getCustomer Sample", + "origin": "API_DEFINITION", + "description": " Returns the requested [Customer][google.cloud.channel.v1.Customer] resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The [Customer][google.cloud.channel.v1.Customer] resource.", + "canonical": true, + "file": "cloud_channel_service.get_customer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetCustomer", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.Customer", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "GetCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetCustomer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CheckCloudIdentityAccountsExist_async", + "title": "CloudChannelReportsService checkCloudIdentityAccountsExist Sample", + "origin": "API_DEFINITION", + "description": " Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.", + "canonical": true, + "file": "cloud_channel_service.check_cloud_identity_accounts_exist.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CheckCloudIdentityAccountsExist", + "fullName": "google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "domain", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.CheckCloudIdentityAccountsExistResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CheckCloudIdentityAccountsExist", + "fullName": "google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CreateCustomer_async", + "title": "CloudChannelReportsService createCustomer Sample", + "origin": "API_DEFINITION", + "description": " Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created [Customer][google.cloud.channel.v1.Customer] resource.", + "canonical": true, + "file": "cloud_channel_service.create_customer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateCustomer", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "customer", + "type": ".google.cloud.channel.v1.Customer" + } + ], + "resultType": ".google.cloud.channel.v1.Customer", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CreateCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateCustomer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_UpdateCustomer_async", + "title": "CloudChannelReportsService updateCustomer Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request. Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.", + "canonical": true, + "file": "cloud_channel_service.update_customer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateCustomer", + "async": true, + "parameters": [ + { + "name": "customer", + "type": ".google.cloud.channel.v1.Customer" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.channel.v1.Customer", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "UpdateCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateCustomer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_DeleteCustomer_async", + "title": "CloudChannelReportsService deleteCustomer Sample", + "origin": "API_DEFINITION", + "description": " Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.", + "canonical": true, + "file": "cloud_channel_service.delete_customer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteCustomer", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "DeleteCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteCustomer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ImportCustomer_async", + "title": "CloudChannelReportsService importCustomer Sample", + "origin": "API_DEFINITION", + "description": " Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The [Customer][google.cloud.channel.v1.Customer].", + "canonical": true, + "file": "cloud_channel_service.import_customer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 92, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.ImportCustomer", + "async": true, + "parameters": [ + { + "name": "domain", + "type": "TYPE_STRING" + }, + { + "name": "cloud_identity_id", + "type": "TYPE_STRING" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "auth_token", + "type": "TYPE_STRING" + }, + { + "name": "overwrite_if_exists", + "type": "TYPE_BOOL" + }, + { + "name": "channel_partner_id", + "type": "TYPE_STRING" + }, + { + "name": "customer", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.Customer", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ImportCustomer", + "fullName": "google.cloud.channel.v1.CloudChannelService.ImportCustomer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ProvisionCloudIdentity_async", + "title": "CloudChannelReportsService provisionCloudIdentity Sample", + "origin": "API_DEFINITION", + "description": " Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.provision_cloud_identity.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ProvisionCloudIdentity", + "fullName": "google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity", + "async": true, + "parameters": [ + { + "name": "customer", + "type": "TYPE_STRING" + }, + { + "name": "cloud_identity_info", + "type": ".google.cloud.channel.v1.CloudIdentityInfo" + }, + { + "name": "user", + "type": ".google.cloud.channel.v1.AdminUser" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ProvisionCloudIdentity", + "fullName": "google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListEntitlements_async", + "title": "CloudChannelReportsService listEntitlements Sample", + "origin": "API_DEFINITION", + "description": " Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.", + "canonical": true, + "file": "cloud_channel_service.list_entitlements.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntitlements", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListEntitlements", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListEntitlementsResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListEntitlements", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListEntitlements", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListTransferableSkus_async", + "title": "CloudChannelReportsService listTransferableSkus Sample", + "origin": "API_DEFINITION", + "description": " List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request. Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The supplied auth token is invalid. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].", + "canonical": true, + "file": "cloud_channel_service.list_transferable_skus.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 97, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTransferableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListTransferableSkus", + "async": true, + "parameters": [ + { + "name": "cloud_identity_id", + "type": "TYPE_STRING" + }, + { + "name": "customer_name", + "type": "TYPE_STRING" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "auth_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListTransferableSkusResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListTransferableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListTransferableSkus", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListTransferableOffers_async", + "title": "CloudChannelReportsService listTransferableOffers Sample", + "origin": "API_DEFINITION", + "description": " List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request. Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.", + "canonical": true, + "file": "cloud_channel_service.list_transferable_offers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 90, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTransferableOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListTransferableOffers", + "async": true, + "parameters": [ + { + "name": "cloud_identity_id", + "type": "TYPE_STRING" + }, + { + "name": "customer_name", + "type": "TYPE_STRING" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "sku", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListTransferableOffersResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListTransferableOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListTransferableOffers", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_GetEntitlement_async", + "title": "CloudChannelReportsService getEntitlement Sample", + "origin": "API_DEFINITION", + "description": " Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.", + "canonical": true, + "file": "cloud_channel_service.get_entitlement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetEntitlement", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.Entitlement", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "GetEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetEntitlement", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CreateEntitlement_async", + "title": "CloudChannelReportsService createEntitlement Sample", + "origin": "API_DEFINITION", + "description": " Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.create_entitlement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateEntitlement", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entitlement", + "type": ".google.cloud.channel.v1.Entitlement" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CreateEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateEntitlement", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ChangeParameters_async", + "title": "CloudChannelReportsService changeParameters Sample", + "origin": "API_DEFINITION", + "description": " Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND: Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.change_parameters.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ChangeParameters", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeParameters", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "parameters", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "purchase_order_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ChangeParameters", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeParameters", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ChangeRenewalSettings_async", + "title": "CloudChannelReportsService changeRenewalSettings Sample", + "origin": "API_DEFINITION", + "description": " Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.change_renewal_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ChangeRenewalSettings", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "renewal_settings", + "type": ".google.cloud.channel.v1.RenewalSettings" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ChangeRenewalSettings", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ChangeOffer_async", + "title": "CloudChannelReportsService changeOffer Sample", + "origin": "API_DEFINITION", + "description": " Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Offer or Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.change_offer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ChangeOffer", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeOffer", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "offer", + "type": "TYPE_STRING" + }, + { + "name": "parameters", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "purchase_order_id", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ChangeOffer", + "fullName": "google.cloud.channel.v1.CloudChannelService.ChangeOffer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_StartPaidService_async", + "title": "CloudChannelReportsService startPaidService Sample", + "origin": "API_DEFINITION", + "description": " Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.start_paid_service.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartPaidService", + "fullName": "google.cloud.channel.v1.CloudChannelService.StartPaidService", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "StartPaidService", + "fullName": "google.cloud.channel.v1.CloudChannelService.StartPaidService", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_SuspendEntitlement_async", + "title": "CloudChannelReportsService suspendEntitlement Sample", + "origin": "API_DEFINITION", + "description": " Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_ACTIVE: Entitlement is not active. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.suspend_entitlement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SuspendEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.SuspendEntitlement", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "SuspendEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.SuspendEntitlement", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CancelEntitlement_async", + "title": "CloudChannelReportsService cancelEntitlement Sample", + "origin": "API_DEFINITION", + "description": " Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.cancel_entitlement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.CancelEntitlement", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CancelEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.CancelEntitlement", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ActivateEntitlement_async", + "title": "CloudChannelReportsService activateEntitlement Sample", + "origin": "API_DEFINITION", + "description": " Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.activate_entitlement.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ActivateEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.ActivateEntitlement", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ActivateEntitlement", + "fullName": "google.cloud.channel.v1.CloudChannelService.ActivateEntitlement", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_TransferEntitlements_async", + "title": "CloudChannelReportsService transferEntitlements Sample", + "origin": "API_DEFINITION", + "description": " Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.transfer_entitlements.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 81, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TransferEntitlements", + "fullName": "google.cloud.channel.v1.CloudChannelService.TransferEntitlements", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entitlements", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "auth_token", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "TransferEntitlements", + "fullName": "google.cloud.channel.v1.CloudChannelService.TransferEntitlements", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_TransferEntitlementsToGoogle_async", + "title": "CloudChannelReportsService transferEntitlementsToGoogle Sample", + "origin": "API_DEFINITION", + "description": " Transfers customer entitlements from their current reseller to Google. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].", + "canonical": true, + "file": "cloud_channel_service.transfer_entitlements_to_google.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TransferEntitlementsToGoogle", + "fullName": "google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entitlements", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "TransferEntitlementsToGoogle", + "fullName": "google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListChannelPartnerLinks_async", + "title": "CloudChannelReportsService listChannelPartnerLinks Sample", + "origin": "API_DEFINITION", + "description": " List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.", + "canonical": true, + "file": "cloud_channel_service.list_channel_partner_links.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListChannelPartnerLinks", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks", + "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.channel.v1.ChannelPartnerLinkView" + } + ], + "resultType": ".google.cloud.channel.v1.ListChannelPartnerLinksResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListChannelPartnerLinks", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_GetChannelPartnerLink_async", + "title": "CloudChannelReportsService getChannelPartnerLink Sample", + "origin": "API_DEFINITION", + "description": " Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.", + "canonical": true, + "file": "cloud_channel_service.get_channel_partner_link.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.channel.v1.ChannelPartnerLinkView" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerLink", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "GetChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CreateChannelPartnerLink_async", + "title": "CloudChannelReportsService createChannelPartnerLink Sample", + "origin": "API_DEFINITION", + "description": " Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.", + "canonical": true, + "file": "cloud_channel_service.create_channel_partner_link.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "channel_partner_link", + "type": ".google.cloud.channel.v1.ChannelPartnerLink" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerLink", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CreateChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_UpdateChannelPartnerLink_async", + "title": "CloudChannelReportsService updateChannelPartnerLink Sample", + "origin": "API_DEFINITION", + "description": " Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.", + "canonical": true, + "file": "cloud_channel_service.update_channel_partner_link.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "channel_partner_link", + "type": ".google.cloud.channel.v1.ChannelPartnerLink" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerLink", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "UpdateChannelPartnerLink", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_GetCustomerRepricingConfig_async", + "title": "CloudChannelReportsService getCustomerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.get_customer_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.CustomerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "GetCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListCustomerRepricingConfigs_async", + "title": "CloudChannelReportsService listCustomerRepricingConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of: * Customer ID * [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] * [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time] If unsuccessful, returns an error.", + "canonical": true, + "file": "cloud_channel_service.list_customer_repricing_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCustomerRepricingConfigs", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs", + "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.channel.v1.ListCustomerRepricingConfigsResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListCustomerRepricingConfigs", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CreateCustomerRepricingConfig_async", + "title": "CloudChannelReportsService createCustomerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. * The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.create_customer_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "customer_repricing_config", + "type": ".google.cloud.channel.v1.CustomerRepricingConfig" + } + ], + "resultType": ".google.cloud.channel.v1.CustomerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CreateCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_UpdateCustomerRepricingConfig_async", + "title": "CloudChannelReportsService updateCustomerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.update_customer_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "customer_repricing_config", + "type": ".google.cloud.channel.v1.CustomerRepricingConfig" + } + ], + "resultType": ".google.cloud.channel.v1.CustomerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "UpdateCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_DeleteCustomerRepricingConfig_async", + "title": "CloudChannelReportsService deleteCustomerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past. * NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.", + "canonical": true, + "file": "cloud_channel_service.delete_customer_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "DeleteCustomerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_GetChannelPartnerRepricingConfig_async", + "title": "CloudChannelReportsService getChannelPartnerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.get_channel_partner_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "GetChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListChannelPartnerRepricingConfigs_async", + "title": "CloudChannelReportsService listChannelPartnerRepricingConfigs Sample", + "origin": "API_DEFINITION", + "description": " Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of: * Channel Partner ID * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] * [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time] If unsuccessful, returns an error.", + "canonical": true, + "file": "cloud_channel_service.list_channel_partner_repricing_configs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListChannelPartnerRepricingConfigs", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs", + "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.channel.v1.ListChannelPartnerRepricingConfigsResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListChannelPartnerRepricingConfigs", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_CreateChannelPartnerRepricingConfig_async", + "title": "CloudChannelReportsService createChannelPartnerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. * The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.create_channel_partner_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "channel_partner_repricing_config", + "type": ".google.cloud.channel.v1.ChannelPartnerRepricingConfig" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "CreateChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_UpdateChannelPartnerRepricingConfig_async", + "title": "CloudChannelReportsService updateChannelPartnerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.", + "canonical": true, + "file": "cloud_channel_service.update_channel_partner_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "channel_partner_repricing_config", + "type": ".google.cloud.channel.v1.ChannelPartnerRepricingConfig" + } + ], + "resultType": ".google.cloud.channel.v1.ChannelPartnerRepricingConfig", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "UpdateChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_DeleteChannelPartnerRepricingConfig_async", + "title": "CloudChannelReportsService deleteChannelPartnerRepricingConfig Sample", + "origin": "API_DEFINITION", + "description": " Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past. * NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.", + "canonical": true, + "file": "cloud_channel_service.delete_channel_partner_repricing_config.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteChannelPartnerRepricingConfig", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "DeleteChannelPartnerRepricingConfig", + "fullName": "google.cloud.channel.v1.CloudChannelService.DeleteChannelPartnerRepricingConfig", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListSkuGroups_async", + "title": "CloudChannelReportsService listSkuGroups Sample", + "origin": "API_DEFINITION", + "description": " Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the [SkuGroup][google.cloud.channel.v1.SkuGroup] resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of [SkuGroup.display_name][google.cloud.channel.v1.SkuGroup.display_name] If unsuccessful, returns an error.", + "canonical": true, + "file": "cloud_channel_service.list_sku_groups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSkuGroups", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkuGroups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListSkuGroupsResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListSkuGroups", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkuGroups", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListSkuGroupBillableSkus_async", + "title": "CloudChannelReportsService listSkuGroupBillableSkus Sample", + "origin": "API_DEFINITION", + "description": " Lists the Billable SKUs in a given SKU group. Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support. Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of: * [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name] * [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name] If unsuccessful, returns an error.", + "canonical": true, + "file": "cloud_channel_service.list_sku_group_billable_skus.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSkuGroupBillableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListSkuGroupBillableSkusResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListSkuGroupBillableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_LookupOffer_async", + "title": "CloudChannelReportsService lookupOffer Sample", + "origin": "API_DEFINITION", + "description": " Returns the requested [Offer][google.cloud.channel.v1.Offer] resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The [Offer][google.cloud.channel.v1.Offer] resource.", + "canonical": true, + "file": "cloud_channel_service.lookup_offer.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupOffer", + "fullName": "google.cloud.channel.v1.CloudChannelService.LookupOffer", + "async": true, + "parameters": [ + { + "name": "entitlement", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.Offer", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "LookupOffer", + "fullName": "google.cloud.channel.v1.CloudChannelService.LookupOffer", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListProducts_async", + "title": "CloudChannelReportsService listProducts Sample", + "origin": "API_DEFINITION", + "description": " Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", + "canonical": true, + "file": "cloud_channel_service.list_products.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListProducts", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListProducts", + "async": true, + "parameters": [ + { + "name": "account", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListProductsResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListProducts", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListProducts", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListSkus_async", + "title": "CloudChannelReportsService listSkus Sample", + "origin": "API_DEFINITION", + "description": " Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", + "canonical": true, + "file": "cloud_channel_service.list_skus.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkus", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "account", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListSkusResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSkus", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListOffers_async", + "title": "CloudChannelReportsService listOffers Sample", + "origin": "API_DEFINITION", + "description": " Lists the Offers the reseller can sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.", + "canonical": true, + "file": "cloud_channel_service.list_offers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListOffers", + "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": "language_code", + "type": "TYPE_STRING" + }, + { + "name": "show_future_offers", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.channel.v1.ListOffersResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListOffers", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListPurchasableSkus_async", + "title": "CloudChannelReportsService listPurchasableSkus Sample", + "origin": "API_DEFINITION", + "description": " Lists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or downgrade for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid.", + "canonical": true, + "file": "cloud_channel_service.list_purchasable_skus.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPurchasableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListPurchasableSkus", + "async": true, + "parameters": [ + { + "name": "create_entitlement_purchase", + "type": ".google.cloud.channel.v1.ListPurchasableSkusRequest.CreateEntitlementPurchase" + }, + { + "name": "change_offer_purchase", + "type": ".google.cloud.channel.v1.ListPurchasableSkusRequest.ChangeOfferPurchase" + }, + { + "name": "customer", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListPurchasableSkusResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListPurchasableSkus", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListPurchasableSkus", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListPurchasableOffers_async", + "title": "CloudChannelReportsService listPurchasableOffers Sample", + "origin": "API_DEFINITION", + "description": " Lists the following: * Offers that you can purchase for a customer. * Offers that you can change for an entitlement. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller * INVALID_ARGUMENT: Required request parameters are missing or invalid.", + "canonical": true, + "file": "cloud_channel_service.list_purchasable_offers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPurchasableOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListPurchasableOffers", + "async": true, + "parameters": [ + { + "name": "create_entitlement_purchase", + "type": ".google.cloud.channel.v1.ListPurchasableOffersRequest.CreateEntitlementPurchase" + }, + { + "name": "change_offer_purchase", + "type": ".google.cloud.channel.v1.ListPurchasableOffersRequest.ChangeOfferPurchase" + }, + { + "name": "customer", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "language_code", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListPurchasableOffersResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListPurchasableOffers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListPurchasableOffers", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_RegisterSubscriber_async", + "title": "CloudChannelReportsService registerSubscriber Sample", + "origin": "API_DEFINITION", + "description": " Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent] Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", + "canonical": true, + "file": "cloud_channel_service.register_subscriber.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RegisterSubscriber", + "fullName": "google.cloud.channel.v1.CloudChannelService.RegisterSubscriber", + "async": true, + "parameters": [ + { + "name": "account", + "type": "TYPE_STRING" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.RegisterSubscriberResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "RegisterSubscriber", + "fullName": "google.cloud.channel.v1.CloudChannelService.RegisterSubscriber", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_UnregisterSubscriber_async", + "title": "CloudChannelReportsService unregisterSubscriber Sample", + "origin": "API_DEFINITION", + "description": " Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", + "canonical": true, + "file": "cloud_channel_service.unregister_subscriber.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UnregisterSubscriber", + "fullName": "google.cloud.channel.v1.CloudChannelService.UnregisterSubscriber", + "async": true, + "parameters": [ + { + "name": "account", + "type": "TYPE_STRING" + }, + { + "name": "service_account", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.UnregisterSubscriberResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "UnregisterSubscriber", + "fullName": "google.cloud.channel.v1.CloudChannelService.UnregisterSubscriber", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListSubscribers_async", + "title": "CloudChannelReportsService listSubscribers Sample", + "origin": "API_DEFINITION", + "description": " Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", + "canonical": true, + "file": "cloud_channel_service.list_subscribers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSubscribers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSubscribers", + "async": true, + "parameters": [ + { + "name": "account", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.channel.v1.ListSubscribersResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListSubscribers", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListSubscribers", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + }, + { + "regionTag": "cloudchannel_v1_generated_CloudChannelService_ListEntitlementChanges_async", + "title": "CloudChannelReportsService listEntitlementChanges Sample", + "origin": "API_DEFINITION", + "description": " List entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different. * INVALID_ARGUMENT: Missing or invalid required fields in the request. * NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter. * INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support. Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.", + "canonical": true, + "file": "cloud_channel_service.list_entitlement_changes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntitlementChanges", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges", + "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.channel.v1.ListEntitlementChangesResponse", + "client": { + "shortName": "CloudChannelServiceClient", + "fullName": "google.cloud.channel.v1.CloudChannelServiceClient" + }, + "method": { + "shortName": "ListEntitlementChanges", + "fullName": "google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges", + "service": { + "shortName": "CloudChannelService", + "fullName": "google.cloud.channel.v1.CloudChannelService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-channel/samples/package.json b/packages/google-cloud-channel/samples/package.json index c7a0c48e457..27e102a8e3e 100644 --- a/packages/google-cloud-channel/samples/package.json +++ b/packages/google-cloud-channel/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" @@ -25,4 +25,4 @@ "chai": "^4.2.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-channel/src/v1/cloud_channel_reports_service_client.ts b/packages/google-cloud-channel/src/v1/cloud_channel_reports_service_client.ts index b6cb70200c6..d94e3b93001 100644 --- a/packages/google-cloud-channel/src/v1/cloud_channel_reports_service_client.ts +++ b/packages/google-cloud-channel/src/v1/cloud_channel_reports_service_client.ts @@ -445,12 +445,12 @@ export class CloudChannelReportsServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata contains an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * To get the results of report generation, call - * {@link google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} * with the - * {@link google.cloud.channel.v1.RunReportJobResponse.report_job|RunReportJobResponse.report_job}. + * {@link protos.google.cloud.channel.v1.RunReportJobResponse.report_job|RunReportJobResponse.report_job}. * * @param {Object} request * The request object that will be sent. @@ -484,8 +484,7 @@ export class CloudChannelReportsServiceClient { * 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/cloud_channel_reports_service.run_report_job.js * region_tag:cloudchannel_v1_generated_CloudChannelReportsService_RunReportJob_async @@ -580,8 +579,7 @@ export class CloudChannelReportsServiceClient { * 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/cloud_channel_reports_service.run_report_job.js * region_tag:cloudchannel_v1_generated_CloudChannelReportsService_RunReportJob_async @@ -611,13 +609,13 @@ export class CloudChannelReportsServiceClient { } /** * Retrieves data generated by - * {@link google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. * * @param {Object} request * The request object that will be sent. * @param {string} request.reportJob * Required. The report job created by - * {@link google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. * Report_job uses the format: * accounts/{account_id}/reportJobs/{report_job_id} * @param {number} [request.pageSize] @@ -630,9 +628,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} * call. * @param {string[]} [request.partitionKeys] * Optional. List of keys specifying which report partitions to return. @@ -640,14 +638,13 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Row | Row}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.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 `fetchReportResultsAsync()` * 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. */ fetchReportResults( @@ -731,7 +728,7 @@ export class CloudChannelReportsServiceClient { * The request object that will be sent. * @param {string} request.reportJob * Required. The report job created by - * {@link google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. * Report_job uses the format: * accounts/{account_id}/reportJobs/{report_job_id} * @param {number} [request.pageSize] @@ -744,9 +741,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} * call. * @param {string[]} [request.partitionKeys] * Optional. List of keys specifying which report partitions to return. @@ -754,13 +751,12 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Row | Row} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.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 `fetchReportResultsAsync()` * 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. */ fetchReportResultsStream( @@ -793,7 +789,7 @@ export class CloudChannelReportsServiceClient { * The request object that will be sent. * @param {string} request.reportJob * Required. The report job created by - * {@link google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.RunReportJob|CloudChannelReportsService.RunReportJob}. * Report_job uses the format: * accounts/{account_id}/reportJobs/{report_job_id} * @param {number} [request.pageSize] @@ -806,9 +802,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.FetchReportResultsResponse.next_page_token|FetchReportResultsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults|CloudChannelReportsService.FetchReportResults} * call. * @param {string[]} [request.partitionKeys] * Optional. List of keys specifying which report partitions to return. @@ -816,12 +812,11 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Row | Row}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.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/v1/cloud_channel_reports_service.fetch_report_results.js * region_tag:cloudchannel_v1_generated_CloudChannelReportsService_FetchReportResults_async @@ -863,9 +858,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} * call. * @param {string} [request.languageCode] * Optional. The BCP-47 language code, such as "en-US". If specified, the @@ -875,14 +870,13 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Report | Report}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Report|Report}. * 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 `listReportsAsync()` * 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. */ listReports( @@ -968,9 +962,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} * call. * @param {string} [request.languageCode] * Optional. The BCP-47 language code, such as "en-US". If specified, the @@ -980,13 +974,12 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Report | Report} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Report|Report} 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 `listReportsAsync()` * 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. */ listReportsStream( @@ -1027,9 +1020,9 @@ export class CloudChannelReportsServiceClient { * @param {string} [request.pageToken] * Optional. A token that specifies a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListReportsResponse.next_page_token|ListReportsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} + * {@link protos.google.cloud.channel.v1.CloudChannelReportsService.ListReports|CloudChannelReportsService.ListReports} * call. * @param {string} [request.languageCode] * Optional. The BCP-47 language code, such as "en-US". If specified, the @@ -1039,12 +1032,11 @@ export class CloudChannelReportsServiceClient { * @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.channel.v1.Report | Report}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Report|Report}. 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/cloud_channel_reports_service.list_reports.js * region_tag:cloudchannel_v1_generated_CloudChannelReportsService_ListReports_async diff --git a/packages/google-cloud-channel/src/v1/cloud_channel_service_client.ts b/packages/google-cloud-channel/src/v1/cloud_channel_service_client.ts index a8592c05226..3e440908b84 100644 --- a/packages/google-cloud-channel/src/v1/cloud_channel_service_client.ts +++ b/packages/google-cloud-channel/src/v1/cloud_channel_service_client.ts @@ -50,14 +50,14 @@ const version = require('../../../package.json').version; * 3. Resellers and distributors can manage customer entitlements. * * CloudChannelService exposes the following resources: - * - {@link google.cloud.channel.v1.Customer|Customer}s: An entity-usually an + * - {@link protos.google.cloud.channel.v1.Customer|Customer}s: An entity-usually an * enterprise-managed by a reseller or distributor. * - * - {@link google.cloud.channel.v1.Entitlement|Entitlement}s: An entity that + * - {@link protos.google.cloud.channel.v1.Entitlement|Entitlement}s: An entity that * provides a customer with the means to use a service. Entitlements are created * or updated as a result of a successful fulfillment. * - * - {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}s: An + * - {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}s: An * entity that identifies links between distributors and their indirect * resellers in a channel. * @class @@ -675,7 +675,7 @@ export class CloudChannelServiceClient { // -- Service calls -- // ------------------- /** - * Returns the requested {@link google.cloud.channel.v1.Customer|Customer} + * Returns the requested {@link protos.google.cloud.channel.v1.Customer|Customer} * resource. * * Possible error codes: @@ -687,7 +687,7 @@ export class CloudChannelServiceClient { * invalid name parameter. * * Return value: - * The {@link google.cloud.channel.v1.Customer|Customer} resource. + * The {@link protos.google.cloud.channel.v1.Customer|Customer} resource. * * @param {Object} request * The request object that will be sent. @@ -697,9 +697,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. - * 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.channel.v1.Customer|Customer}. + * 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/cloud_channel_service.get_customer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_GetCustomer_async @@ -783,12 +782,12 @@ export class CloudChannelServiceClient { * * Return value: * A list of - * {@link google.cloud.channel.v1.CloudIdentityCustomerAccount|CloudIdentityCustomerAccount} + * {@link protos.google.cloud.channel.v1.CloudIdentityCustomerAccount|CloudIdentityCustomerAccount} * resources for the domain (may be empty) * * Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if * no - * {@link google.cloud.channel.v1.CloudIdentityCustomerAccount|CloudIdentityCustomerAccount} + * {@link protos.google.cloud.channel.v1.CloudIdentityCustomerAccount|CloudIdentityCustomerAccount} * resources match the domain. * * @param {Object} request @@ -801,9 +800,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.CheckCloudIdentityAccountsExistResponse | CheckCloudIdentityAccountsExistResponse}. - * 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.channel.v1.CheckCloudIdentityAccountsExistResponse|CheckCloudIdentityAccountsExistResponse}. + * 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/cloud_channel_service.check_cloud_identity_accounts_exist.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CheckCloudIdentityAccountsExist_async @@ -893,7 +891,7 @@ export class CloudChannelServiceClient { ); } /** - * Creates a new {@link google.cloud.channel.v1.Customer|Customer} resource under + * Creates a new {@link protos.google.cloud.channel.v1.Customer|Customer} resource under * the reseller or distributor account. * * Possible error codes: @@ -905,7 +903,7 @@ export class CloudChannelServiceClient { * * Domain field value doesn't match the primary email domain. * * Return value: - * The newly created {@link google.cloud.channel.v1.Customer|Customer} resource. + * The newly created {@link protos.google.cloud.channel.v1.Customer|Customer} resource. * * @param {Object} request * The request object that will be sent. @@ -917,9 +915,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. - * 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.channel.v1.Customer|Customer}. + * 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/cloud_channel_service.create_customer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateCustomer_async @@ -993,7 +990,7 @@ export class CloudChannelServiceClient { return this.innerApiCalls.createCustomer(request, options, callback); } /** - * Updates an existing {@link google.cloud.channel.v1.Customer|Customer} resource + * Updates an existing {@link protos.google.cloud.channel.v1.Customer|Customer} resource * for the reseller or distributor. * * Possible error codes: @@ -1001,11 +998,11 @@ export class CloudChannelServiceClient { * * PERMISSION_DENIED: The reseller account making the request is different * from the reseller account in the API request. * * INVALID_ARGUMENT: Required request parameters are missing or invalid. - * * NOT_FOUND: No {@link google.cloud.channel.v1.Customer|Customer} resource found + * * NOT_FOUND: No {@link protos.google.cloud.channel.v1.Customer|Customer} resource found * for the name in the request. * * Return value: - * The updated {@link google.cloud.channel.v1.Customer|Customer} resource. + * The updated {@link protos.google.cloud.channel.v1.Customer|Customer} resource. * * @param {Object} request * The request object that will be sent. @@ -1017,9 +1014,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. - * 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.channel.v1.Customer|Customer}. + * 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/cloud_channel_service.update_customer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_UpdateCustomer_async @@ -1093,7 +1089,7 @@ export class CloudChannelServiceClient { return this.innerApiCalls.updateCustomer(request, options, callback); } /** - * Deletes the given {@link google.cloud.channel.v1.Customer|Customer} permanently. + * Deletes the given {@link protos.google.cloud.channel.v1.Customer|Customer} permanently. * * Possible error codes: * @@ -1101,7 +1097,7 @@ export class CloudChannelServiceClient { * this customer. * * INVALID_ARGUMENT: Required request parameters are missing or invalid. * * FAILED_PRECONDITION: The customer has existing entitlements. - * * NOT_FOUND: No {@link google.cloud.channel.v1.Customer|Customer} resource found + * * NOT_FOUND: No {@link protos.google.cloud.channel.v1.Customer|Customer} resource found * for the name in the request. * * @param {Object} request @@ -1111,9 +1107,8 @@ export class CloudChannelServiceClient { * @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/cloud_channel_service.delete_customer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_DeleteCustomer_async @@ -1187,7 +1182,7 @@ export class CloudChannelServiceClient { return this.innerApiCalls.deleteCustomer(request, options, callback); } /** - * Imports a {@link google.cloud.channel.v1.Customer|Customer} from the Cloud + * Imports a {@link protos.google.cloud.channel.v1.Customer|Customer} from the Cloud * Identity associated with the provided Cloud Identity ID or domain before a * TransferEntitlements call. If a linked Customer already exists and * overwrite_if_exists is true, it will update that Customer's data. @@ -1203,7 +1198,7 @@ export class CloudChannelServiceClient { * fields. Requires an overwrite. * * Return value: - * The {@link google.cloud.channel.v1.Customer|Customer}. + * The {@link protos.google.cloud.channel.v1.Customer|Customer}. * * @param {Object} request * The request object that will be sent. @@ -1236,9 +1231,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. - * 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.channel.v1.Customer|Customer}. + * 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/cloud_channel_service.import_customer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ImportCustomer_async @@ -1312,7 +1306,7 @@ export class CloudChannelServiceClient { return this.innerApiCalls.importCustomer(request, options, callback); } /** - * Returns the requested {@link google.cloud.channel.v1.Entitlement|Entitlement} + * Returns the requested {@link protos.google.cloud.channel.v1.Entitlement|Entitlement} * resource. * * Possible error codes: @@ -1322,7 +1316,7 @@ export class CloudChannelServiceClient { * * NOT_FOUND: The customer entitlement was not found. * * Return value: - * The requested {@link google.cloud.channel.v1.Entitlement|Entitlement} resource. + * The requested {@link protos.google.cloud.channel.v1.Entitlement|Entitlement} resource. * * @param {Object} request * The request object that will be sent. @@ -1333,9 +1327,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Entitlement | Entitlement}. - * 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.channel.v1.Entitlement|Entitlement}. + * 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/cloud_channel_service.get_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_GetEntitlement_async @@ -1410,7 +1403,7 @@ export class CloudChannelServiceClient { } /** * Returns the requested - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resource. + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resource. * You must be a distributor to call this method. * * Possible error codes: @@ -1422,7 +1415,7 @@ export class CloudChannelServiceClient { * invalid channel partner link name. * * Return value: - * The {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} + * The {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} * resource. * * @param {Object} request @@ -1436,9 +1429,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink}. - * 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.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. + * 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/cloud_channel_service.get_channel_partner_link.js * region_tag:cloudchannel_v1_generated_CloudChannelService_GetChannelPartnerLink_async @@ -1539,7 +1531,7 @@ export class CloudChannelServiceClient { * Contact Cloud Channel support. * * Return value: - * The new {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} + * The new {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} * resource. * * @param {Object} request @@ -1555,9 +1547,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink}. - * 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.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. + * 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/cloud_channel_service.create_channel_partner_link.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateChannelPartnerLink_async @@ -1668,7 +1659,7 @@ export class CloudChannelServiceClient { * * Return value: * The updated - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resource. + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resource. * * @param {Object} request * The request object that will be sent. @@ -1686,9 +1677,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink}. - * 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.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. + * 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/cloud_channel_service.update_channel_partner_link.js * region_tag:cloudchannel_v1_generated_CloudChannelService_UpdateChannelPartnerLink_async @@ -1786,14 +1776,14 @@ export class CloudChannelServiceClient { * * PERMISSION_DENIED: If the account making the request and the account * being queried are different. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * was not found. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -1805,9 +1795,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig}. - * 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.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig}. + * 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/cloud_channel_service.get_customer_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_GetCustomerRepricingConfig_async @@ -1899,13 +1888,13 @@ export class CloudChannelServiceClient { /** * Creates a CustomerRepricingConfig. Call this method to set modifications * for a specific customer's bill. You can only create configs if the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is a future month. If needed, you can create a config for the current * month, with some restrictions. * * When creating a config for a future month, make sure there are no existing * configs for that - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * The following restrictions are for creating configs in the current month. * @@ -1914,13 +1903,13 @@ export class CloudChannelServiceClient { * * The new config will not modify exports used with other configs. * Changes to the config may be immediate, but may take up to 24 hours. * * There is a limit of ten configs for any - * {@link google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement} + * {@link protos.google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement} * or - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * The contained - * {@link google.cloud.channel.v1.CustomerRepricingConfig.repricing_config|CustomerRepricingConfig.repricing_config} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig.repricing_config|CustomerRepricingConfig.repricing_config} * vaule must be different from the value used in the current config for a - * {@link google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement}. * * Possible Error Codes: * @@ -1930,14 +1919,14 @@ export class CloudChannelServiceClient { * request. Also displays if the updated config is for the current month or * past months. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the updated - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -1951,9 +1940,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig}. - * 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.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig}. + * 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/cloud_channel_service.create_customer_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateCustomerRepricingConfig_async @@ -2048,11 +2036,11 @@ export class CloudChannelServiceClient { * CustomerRepricingConfig. * * You can only update configs if the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is a future month. To make changes to configs for the current month, use - * {@link google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig|CreateCustomerRepricingConfig}, + * {@link protos.google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig|CreateCustomerRepricingConfig}, * taking note of its restrictions. You cannot update the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * When updating a config in the future: * @@ -2066,14 +2054,14 @@ export class CloudChannelServiceClient { * request. Also displays if the updated config is for the current month or * past months. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the updated - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -2083,9 +2071,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig}. - * 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.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig}. + * 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/cloud_channel_service.update_customer_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_UpdateCustomerRepricingConfig_async @@ -2177,9 +2164,9 @@ export class CloudChannelServiceClient { } /** * Deletes the given - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * permanently. You can only delete configs if their - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is set to a date after the current month. * * Possible error codes: @@ -2188,10 +2175,10 @@ export class CloudChannelServiceClient { * this customer. * * INVALID_ARGUMENT: Required request parameters are missing or invalid. * * FAILED_PRECONDITION: The - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * is active or in the past. * * NOT_FOUND: No - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * found for the name in the request. * * @param {Object} request @@ -2203,9 +2190,8 @@ export class CloudChannelServiceClient { * @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/cloud_channel_service.delete_customer_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_DeleteCustomerRepricingConfig_async @@ -2303,14 +2289,14 @@ export class CloudChannelServiceClient { * * PERMISSION_DENIED: If the account making the request and the account * being queried are different. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * was not found. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -2322,9 +2308,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig}. - * 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.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig}. + * 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/cloud_channel_service.get_channel_partner_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_GetChannelPartnerRepricingConfig_async @@ -2417,13 +2402,13 @@ export class CloudChannelServiceClient { * Creates a ChannelPartnerRepricingConfig. Call this method to set * modifications for a specific ChannelPartner's bill. You can only create * configs if the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is a future month. If needed, you can create a config for the current * month, with some restrictions. * * When creating a config for a future month, make sure there are no existing * configs for that - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * The following restrictions are for creating configs in the current month. * @@ -2432,9 +2417,9 @@ export class CloudChannelServiceClient { * * The new config will not modify exports used with other configs. * Changes to the config may be immediate, but may take up to 24 hours. * * There is a limit of ten configs for any ChannelPartner or - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * The contained - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config|ChannelPartnerRepricingConfig.repricing_config} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config|ChannelPartnerRepricingConfig.repricing_config} * vaule must be different from the value used in the current config for a * ChannelPartner. * @@ -2446,14 +2431,14 @@ export class CloudChannelServiceClient { * request. Also displays if the updated config is for the current month or * past months. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the updated - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -2467,9 +2452,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig}. - * 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.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig}. + * 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/cloud_channel_service.create_channel_partner_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateChannelPartnerRepricingConfig_async @@ -2564,11 +2548,11 @@ export class CloudChannelServiceClient { * the existing CustomerRepricingConfig. * * You can only update configs if the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is a future month. To make changes to configs for the current month, use - * {@link google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig|CreateChannelPartnerRepricingConfig}, + * {@link protos.google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig|CreateChannelPartnerRepricingConfig}, * taking note of its restrictions. You cannot update the - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month}. * * When updating a config in the future: * @@ -2582,14 +2566,14 @@ export class CloudChannelServiceClient { * request. Also displays if the updated config is for the current month or * past months. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the updated - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * resource, otherwise returns an error. * * @param {Object} request @@ -2599,9 +2583,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig}. - * 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.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig}. + * 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/cloud_channel_service.update_channel_partner_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_UpdateChannelPartnerRepricingConfig_async @@ -2693,9 +2676,9 @@ export class CloudChannelServiceClient { } /** * Deletes the given - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * permanently. You can only delete configs if their - * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} * is set to a date after the current month. * * Possible error codes: @@ -2704,10 +2687,10 @@ export class CloudChannelServiceClient { * this customer. * * INVALID_ARGUMENT: Required request parameters are missing or invalid. * * FAILED_PRECONDITION: The - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * is active or in the past. * * NOT_FOUND: No - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * found for the name in the request. * * @param {Object} request @@ -2718,9 +2701,8 @@ export class CloudChannelServiceClient { * @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/cloud_channel_service.delete_channel_partner_repricing_config.js * region_tag:cloudchannel_v1_generated_CloudChannelService_DeleteChannelPartnerRepricingConfig_async @@ -2810,7 +2792,7 @@ export class CloudChannelServiceClient { ); } /** - * Returns the requested {@link google.cloud.channel.v1.Offer|Offer} resource. + * Returns the requested {@link protos.google.cloud.channel.v1.Offer|Offer} resource. * * Possible error codes: * @@ -2819,7 +2801,7 @@ export class CloudChannelServiceClient { * * NOT_FOUND: Entitlement or offer was not found. * * Return value: - * The {@link google.cloud.channel.v1.Offer|Offer} resource. + * The {@link protos.google.cloud.channel.v1.Offer|Offer} resource. * * @param {Object} request * The request object that will be sent. @@ -2830,9 +2812,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.Offer | Offer}. - * 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.channel.v1.Offer|Offer}. + * 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/cloud_channel_service.lookup_offer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_LookupOffer_async @@ -2907,7 +2888,7 @@ export class CloudChannelServiceClient { * Registers a service account with subscriber privileges on the Cloud Pub/Sub * topic for this Channel Services account. After you create a * subscriber, you get the events through - * {@link google.cloud.channel.v1.SubscriberEvent|SubscriberEvent} + * {@link protos.google.cloud.channel.v1.SubscriberEvent|SubscriberEvent} * * Possible error codes: * @@ -2933,9 +2914,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.RegisterSubscriberResponse | RegisterSubscriberResponse}. - * 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.channel.v1.RegisterSubscriberResponse|RegisterSubscriberResponse}. + * 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/cloud_channel_service.register_subscriber.js * region_tag:cloudchannel_v1_generated_CloudChannelService_RegisterSubscriber_async @@ -3047,9 +3027,8 @@ export class CloudChannelServiceClient { * @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.channel.v1.UnregisterSubscriberResponse | UnregisterSubscriberResponse}. - * 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.channel.v1.UnregisterSubscriberResponse|UnregisterSubscriberResponse}. + * 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/cloud_channel_service.unregister_subscriber.js * region_tag:cloudchannel_v1_generated_CloudChannelService_UnregisterSubscriber_async @@ -3150,7 +3129,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata contains an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -3169,8 +3148,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.provision_cloud_identity.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ProvisionCloudIdentity_async @@ -3269,8 +3247,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.provision_cloud_identity.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ProvisionCloudIdentity_async @@ -3334,7 +3311,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -3363,8 +3340,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.create_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateEntitlement_async @@ -3459,8 +3435,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.create_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CreateEntitlement_async @@ -3511,7 +3486,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -3524,7 +3499,7 @@ export class CloudChannelServiceClient { * parameters. * * To view the available Parameters for a request, refer to the - * {@link google.cloud.channel.v1.Offer.parameter_definitions|Offer.parameter_definitions} + * {@link protos.google.cloud.channel.v1.Offer.parameter_definitions|Offer.parameter_definitions} * from the desired offer. * @param {string} [request.requestId] * Optional. You can specify an optional unique request ID, and if you need to @@ -3547,8 +3522,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_parameters.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeParameters_async @@ -3643,8 +3617,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_parameters.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeParameters_async @@ -3695,7 +3668,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -3724,8 +3697,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_renewal_settings.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeRenewalSettings_async @@ -3820,8 +3792,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_renewal_settings.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeRenewalSettings_async @@ -3870,7 +3841,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -3884,7 +3855,7 @@ export class CloudChannelServiceClient { * @param {number[]} [request.parameters] * Optional. Parameters needed to purchase the Offer. To view the available * Parameters refer to the - * {@link google.cloud.channel.v1.Offer.parameter_definitions|Offer.parameter_definitions} + * {@link protos.google.cloud.channel.v1.Offer.parameter_definitions|Offer.parameter_definitions} * from the desired offer. * @param {string} [request.purchaseOrderId] * Optional. Purchase order id provided by the reseller. @@ -3907,8 +3878,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_offer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeOffer_async @@ -4003,8 +3973,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.change_offer.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ChangeOffer_async @@ -4056,7 +4025,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4083,8 +4052,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.start_paid_service.js * region_tag:cloudchannel_v1_generated_CloudChannelService_StartPaidService_async @@ -4179,8 +4147,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.start_paid_service.js * region_tag:cloudchannel_v1_generated_CloudChannelService_StartPaidService_async @@ -4229,7 +4196,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4256,8 +4223,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.suspend_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_SuspendEntitlement_async @@ -4352,8 +4318,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.suspend_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_SuspendEntitlement_async @@ -4407,7 +4372,7 @@ export class CloudChannelServiceClient { * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The response will contain * google.protobuf.Empty on success. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4434,8 +4399,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.cancel_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CancelEntitlement_async @@ -4530,8 +4494,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.cancel_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_CancelEntitlement_async @@ -4586,7 +4549,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4613,8 +4576,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.activate_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ActivateEntitlement_async @@ -4709,8 +4671,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.activate_entitlement.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ActivateEntitlement_async @@ -4767,7 +4728,7 @@ export class CloudChannelServiceClient { * * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4801,8 +4762,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.transfer_entitlements.js * region_tag:cloudchannel_v1_generated_CloudChannelService_TransferEntitlements_async @@ -4897,8 +4857,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.transfer_entitlements.js * region_tag:cloudchannel_v1_generated_CloudChannelService_TransferEntitlements_async @@ -4955,7 +4914,7 @@ export class CloudChannelServiceClient { * To get the results of the operation, call the GetOperation method of * CloudChannelOperationsService. The response will contain * google.protobuf.Empty on success. The Operation metadata will contain an - * instance of {@link google.cloud.channel.v1.OperationMetadata|OperationMetadata}. + * instance of {@link protos.google.cloud.channel.v1.OperationMetadata|OperationMetadata}. * * @param {Object} request * The request object that will be sent. @@ -4984,8 +4943,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.transfer_entitlements_to_google.js * region_tag:cloudchannel_v1_generated_CloudChannelService_TransferEntitlementsToGoogle_async @@ -5084,8 +5042,7 @@ export class CloudChannelServiceClient { * 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/cloud_channel_service.transfer_entitlements_to_google.js * region_tag:cloudchannel_v1_generated_CloudChannelService_TransferEntitlementsToGoogle_async @@ -5114,7 +5071,7 @@ export class CloudChannelServiceClient { >; } /** - * List {@link google.cloud.channel.v1.Customer|Customer}s. + * List {@link protos.google.cloud.channel.v1.Customer|Customer}s. * * Possible error codes: * @@ -5123,7 +5080,7 @@ export class CloudChannelServiceClient { * * INVALID_ARGUMENT: Required request parameters are missing or invalid. * * Return value: - * List of {@link google.cloud.channel.v1.Customer|Customer}s, or an empty list if + * List of {@link protos.google.cloud.channel.v1.Customer|Customer}s, or an empty list if * there are no customers. * * @param {Object} request @@ -5138,9 +5095,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results other than the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} * call. * @param {string} [request.filter] * Optional. Filters applied to the [CloudChannelService.ListCustomers] @@ -5150,14 +5107,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Customer|Customer}. * 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 `listCustomersAsync()` * 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. */ listCustomers( @@ -5243,9 +5199,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results other than the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} * call. * @param {string} [request.filter] * Optional. Filters applied to the [CloudChannelService.ListCustomers] @@ -5255,13 +5211,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Customer|Customer} 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 `listCustomersAsync()` * 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. */ listCustomersStream( @@ -5302,9 +5257,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results other than the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomersResponse.next_page_token|ListCustomersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomers|CloudChannelService.ListCustomers} * call. * @param {string} [request.filter] * Optional. Filters applied to the [CloudChannelService.ListCustomers] @@ -5314,12 +5269,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.Customer | Customer}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Customer|Customer}. 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/cloud_channel_service.list_customers.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListCustomers_async @@ -5346,7 +5300,7 @@ export class CloudChannelServiceClient { ) as AsyncIterable; } /** - * Lists {@link google.cloud.channel.v1.Entitlement|Entitlement}s belonging to a + * Lists {@link protos.google.cloud.channel.v1.Entitlement|Entitlement}s belonging to a * customer. * * Possible error codes: @@ -5356,7 +5310,7 @@ export class CloudChannelServiceClient { * * Return value: * A list of the customer's - * {@link google.cloud.channel.v1.Entitlement|Entitlement}s. + * {@link protos.google.cloud.channel.v1.Entitlement|Entitlement}s. * * @param {Object} request * The request object that will be sent. @@ -5371,21 +5325,20 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} * call. * @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.channel.v1.Entitlement | Entitlement}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Entitlement|Entitlement}. * 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 `listEntitlementsAsync()` * 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. */ listEntitlements( @@ -5478,20 +5431,19 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} * call. * @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.channel.v1.Entitlement | Entitlement} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Entitlement|Entitlement} 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 `listEntitlementsAsync()` * 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. */ listEntitlementsStream( @@ -5533,19 +5485,18 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListEntitlementsResponse.next_page_token|ListEntitlementsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlements|CloudChannelService.ListEntitlements} * call. * @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.channel.v1.Entitlement | Entitlement}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Entitlement|Entitlement}. 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/cloud_channel_service.list_entitlements.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListEntitlements_async @@ -5572,7 +5523,7 @@ export class CloudChannelServiceClient { ) as AsyncIterable; } /** - * List {@link google.cloud.channel.v1.TransferableSku|TransferableSku}s of a + * List {@link protos.google.cloud.channel.v1.TransferableSku|TransferableSku}s of a * customer based on the Cloud Identity ID or Customer Name in the request. * * Use this method to list the entitlements information of an @@ -5590,7 +5541,7 @@ export class CloudChannelServiceClient { * * Return value: * A list of the customer's - * {@link google.cloud.channel.v1.TransferableSku|TransferableSku}. + * {@link protos.google.cloud.channel.v1.TransferableSku|TransferableSku}. * * @param {Object} request * The request object that will be sent. @@ -5612,9 +5563,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} * call. Optional. * @param {string} [request.authToken] * Optional. The super admin of the resold customer generates this token to @@ -5629,14 +5580,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableSku | TransferableSku}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.TransferableSku|TransferableSku}. * 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 `listTransferableSkusAsync()` * 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. */ listTransferableSkus( @@ -5736,9 +5686,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} * call. Optional. * @param {string} [request.authToken] * Optional. The super admin of the resold customer generates this token to @@ -5753,13 +5703,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableSku | TransferableSku} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.TransferableSku|TransferableSku} 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 `listTransferableSkusAsync()` * 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. */ listTransferableSkusStream( @@ -5808,9 +5757,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableSkusResponse.next_page_token|ListTransferableSkusResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableSkus|CloudChannelService.ListTransferableSkus} * call. Optional. * @param {string} [request.authToken] * Optional. The super admin of the resold customer generates this token to @@ -5825,12 +5774,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableSku | TransferableSku}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.TransferableSku|TransferableSku}. 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/cloud_channel_service.list_transferable_skus.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListTransferableSkus_async @@ -5857,7 +5805,7 @@ export class CloudChannelServiceClient { ) as AsyncIterable; } /** - * List {@link google.cloud.channel.v1.TransferableOffer|TransferableOffer}s of a + * List {@link protos.google.cloud.channel.v1.TransferableOffer|TransferableOffer}s of a * customer based on Cloud Identity ID or Customer Name in the request. * * Use this method when a reseller gets the entitlement information of an @@ -5875,7 +5823,7 @@ export class CloudChannelServiceClient { * * INVALID_ARGUMENT: Required request parameters are missing or invalid. * * Return value: - * List of {@link google.cloud.channel.v1.TransferableOffer|TransferableOffer} for + * List of {@link protos.google.cloud.channel.v1.TransferableOffer|TransferableOffer} for * the given customer and SKU. * * @param {Object} request @@ -5894,9 +5842,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} * call. * @param {string} request.sku * Required. The SKU to look up Offers for. @@ -5907,14 +5855,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableOffer | TransferableOffer}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.TransferableOffer|TransferableOffer}. * 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 `listTransferableOffersAsync()` * 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. */ listTransferableOffers( @@ -6014,9 +5961,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} * call. * @param {string} request.sku * Required. The SKU to look up Offers for. @@ -6027,13 +5974,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableOffer | TransferableOffer} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.TransferableOffer|TransferableOffer} 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 `listTransferableOffersAsync()` * 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. */ listTransferableOffersStream( @@ -6078,9 +6024,9 @@ export class CloudChannelServiceClient { * @param {string} request.pageToken * A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListTransferableOffersResponse.next_page_token|ListTransferableOffersResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListTransferableOffers|CloudChannelService.ListTransferableOffers} * call. * @param {string} request.sku * Required. The SKU to look up Offers for. @@ -6091,12 +6037,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.TransferableOffer | TransferableOffer}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.TransferableOffer|TransferableOffer}. 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/cloud_channel_service.list_transferable_offers.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListTransferableOffers_async @@ -6123,7 +6068,7 @@ export class CloudChannelServiceClient { ) as AsyncIterable; } /** - * List {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}s + * List {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}s * belonging to a distributor. You must be a distributor to call this method. * * Possible error codes: @@ -6134,7 +6079,7 @@ export class CloudChannelServiceClient { * * Return value: * The list of the distributor account's - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resources. + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} resources. * * @param {Object} request * The request object that will be sent. @@ -6148,23 +6093,22 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} * call. * @param {google.cloud.channel.v1.ChannelPartnerLinkView} [request.view] * Optional. The level of granularity the ChannelPartnerLink will display. * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. * 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 `listChannelPartnerLinksAsync()` * 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. */ listChannelPartnerLinks( @@ -6260,22 +6204,21 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} * call. * @param {google.cloud.channel.v1.ChannelPartnerLinkView} [request.view] * Optional. The level of granularity the ChannelPartnerLink will display. * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink} 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 `listChannelPartnerLinksAsync()` * 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. */ listChannelPartnerLinksStream( @@ -6316,21 +6259,20 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token for a page of results other than the first page. * Obtained using - * {@link google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerLinksResponse.next_page_token|ListChannelPartnerLinksResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks|CloudChannelService.ListChannelPartnerLinks} * call. * @param {google.cloud.channel.v1.ChannelPartnerLinkView} [request.view] * Optional. The level of granularity the ChannelPartnerLink will display. * @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.channel.v1.ChannelPartnerLink | ChannelPartnerLink}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. 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/cloud_channel_service.list_channel_partner_links.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListChannelPartnerLinks_async @@ -6365,21 +6307,21 @@ export class CloudChannelServiceClient { * * PERMISSION_DENIED: If the account making the request and the account * being queried are different. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the - * {@link google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} * resources. The data for each resource is displayed in the ascending order * of: * * * Customer ID - * * {@link google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement} - * * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} - * * {@link google.cloud.channel.v1.CustomerRepricingConfig.update_time|CustomerRepricingConfig.update_time} + * * {@link protos.google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement|RepricingConfig.EntitlementGranularity.entitlement} + * * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig.update_time|CustomerRepricingConfig.update_time} * * If unsuccessful, returns an error. * @@ -6397,9 +6339,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] @@ -6412,14 +6354,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig}. * 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 `listCustomerRepricingConfigsAsync()` * 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. */ listCustomerRepricingConfigs( @@ -6517,9 +6458,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] @@ -6532,13 +6473,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig} 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 `listCustomerRepricingConfigsAsync()` * 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. */ listCustomerRepricingConfigsStream( @@ -6581,9 +6521,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListCustomerRepricingConfigsResponse.next_page_token|ListCustomerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs|CloudChannelService.ListCustomerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for [CloudChannelService.ListCustomerRepricingConfigs] @@ -6596,12 +6536,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.CustomerRepricingConfig | CustomerRepricingConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.CustomerRepricingConfig|CustomerRepricingConfig}. 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/cloud_channel_service.list_customer_repricing_configs.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListCustomerRepricingConfigs_async @@ -6636,20 +6575,20 @@ export class CloudChannelServiceClient { * * PERMISSION_DENIED: If the account making the request and the account * being queried are different. * * NOT_FOUND: The - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * specified does not exist or is not associated with the given account. * * INTERNAL: Any non-user error related to technical issues in the * backend. In this case, contact Cloud Channel support. * * Return Value: * If successful, the - * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} * resources. The data for each resource is displayed in the ascending order * of: * * * Channel Partner ID - * * {@link google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} - * * {@link google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time|ChannelPartnerRepricingConfig.update_time} + * * {@link protos.google.cloud.channel.v1.RepricingConfig.effective_invoice_month|RepricingConfig.effective_invoice_month} + * * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time|ChannelPartnerRepricingConfig.update_time} * * If unsuccessful, returns an error. * @@ -6657,7 +6596,7 @@ export class CloudChannelServiceClient { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the account's - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent * uses the format: * accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. * Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs @@ -6669,9 +6608,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for @@ -6686,14 +6625,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig}. * 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 `listChannelPartnerRepricingConfigsAsync()` * 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. */ listChannelPartnerRepricingConfigs( @@ -6781,7 +6719,7 @@ export class CloudChannelServiceClient { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the account's - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent * uses the format: * accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. * Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs @@ -6793,9 +6731,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for @@ -6810,13 +6748,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig} 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 `listChannelPartnerRepricingConfigsAsync()` * 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. */ listChannelPartnerRepricingConfigsStream( @@ -6850,7 +6787,7 @@ export class CloudChannelServiceClient { * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the account's - * {@link google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent + * {@link protos.google.cloud.channel.v1.ChannelPartnerLink|ChannelPartnerLink}. Parent * uses the format: * accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. * Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs @@ -6862,9 +6799,9 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} + * {@link protos.google.cloud.channel.v1.ListChannelPartnerRepricingConfigsResponse.next_page_token|ListChannelPartnerRepricingConfigsResponse.next_page_token} * of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs|CloudChannelService.ListChannelPartnerRepricingConfigs} * call. * @param {string} [request.filter] * Optional. A filter for @@ -6879,12 +6816,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.ChannelPartnerRepricingConfig | ChannelPartnerRepricingConfig}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.ChannelPartnerRepricingConfig|ChannelPartnerRepricingConfig}. 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/cloud_channel_service.list_channel_partner_repricing_configs.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListChannelPartnerRepricingConfigs_async @@ -6924,11 +6860,11 @@ export class CloudChannelServiceClient { * backend. In this case, contact Cloud Channel support. * * Return Value: - * If successful, the {@link google.cloud.channel.v1.SkuGroup|SkuGroup} resources. + * If successful, the {@link protos.google.cloud.channel.v1.SkuGroup|SkuGroup} resources. * The data for each resource is displayed in the alphabetical order of SKU * group display name. * The data for each resource is displayed in the ascending order of - * {@link google.cloud.channel.v1.SkuGroup.display_name|SkuGroup.display_name} + * {@link protos.google.cloud.channel.v1.SkuGroup.display_name|SkuGroup.display_name} * * If unsuccessful, returns an error. * @@ -6945,20 +6881,19 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroups.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} + * {@link protos.|ListSkuGroups.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} * call. * @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.channel.v1.SkuGroup | SkuGroup}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.SkuGroup|SkuGroup}. * 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 `listSkuGroupsAsync()` * 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. */ listSkuGroups( @@ -7045,19 +6980,18 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroups.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} + * {@link protos.|ListSkuGroups.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} * call. * @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.channel.v1.SkuGroup | SkuGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.SkuGroup|SkuGroup} 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 `listSkuGroupsAsync()` * 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. */ listSkuGroupsStream( @@ -7099,18 +7033,17 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroups.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} + * {@link protos.|ListSkuGroups.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroups|CloudChannelService.ListSkuGroups} * call. * @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.channel.v1.SkuGroup | SkuGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.SkuGroup|SkuGroup}. 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/cloud_channel_service.list_sku_groups.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListSkuGroups_async @@ -7148,12 +7081,12 @@ export class CloudChannelServiceClient { * backend. In this case, contact cloud channel support. * * Return Value: - * If successful, the {@link google.cloud.channel.v1.BillableSku|BillableSku} + * If successful, the {@link protos.google.cloud.channel.v1.BillableSku|BillableSku} * resources. The data for each resource is displayed in the ascending order * of: * - * * {@link google.cloud.channel.v1.BillableSku.service_display_name|BillableSku.service_display_name} - * * {@link google.cloud.channel.v1.BillableSku.sku_display_name|BillableSku.sku_display_name} + * * {@link protos.google.cloud.channel.v1.BillableSku.service_display_name|BillableSku.service_display_name} + * * {@link protos.google.cloud.channel.v1.BillableSku.sku_display_name|BillableSku.sku_display_name} * * If unsuccessful, returns an error. * @@ -7169,20 +7102,19 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroupBillableSkus.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} + * {@link protos.|ListSkuGroupBillableSkus.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} * call. * @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.channel.v1.BillableSku | BillableSku}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.BillableSku|BillableSku}. * 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 `listSkuGroupBillableSkusAsync()` * 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. */ listSkuGroupBillableSkus( @@ -7278,19 +7210,18 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroupBillableSkus.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} + * {@link protos.|ListSkuGroupBillableSkus.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} * call. * @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.channel.v1.BillableSku | BillableSku} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.BillableSku|BillableSku} 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 `listSkuGroupBillableSkusAsync()` * 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. */ listSkuGroupBillableSkusStream( @@ -7331,18 +7262,17 @@ export class CloudChannelServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results beyond the first page. * Obtained through - * {@link |ListSkuGroupBillableSkus.next_page_token} of the previous - * {@link google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} + * {@link protos.|ListSkuGroupBillableSkus.next_page_token} of the previous + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListSkuGroupBillableSkus|CloudChannelService.ListSkuGroupBillableSkus} * call. * @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.channel.v1.BillableSku | BillableSku}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.BillableSku|BillableSku}. 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/cloud_channel_service.list_sku_group_billable_skus.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListSkuGroupBillableSkus_async @@ -7393,14 +7323,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.Product | Product}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Product|Product}. * 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 `listProductsAsync()` * 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. */ listProducts( @@ -7488,13 +7417,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.Product | Product} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Product|Product} 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 `listProductsAsync()` * 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. */ listProductsStream( @@ -7537,12 +7465,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.Product | Product}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Product|Product}. 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/cloud_channel_service.list_products.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListProducts_async @@ -7594,14 +7521,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.Sku | Sku}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Sku|Sku}. * 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 `listSkusAsync()` * 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. */ listSkus( @@ -7696,13 +7622,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.Sku | Sku} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Sku|Sku} 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 `listSkusAsync()` * 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. */ listSkusStream( @@ -7754,12 +7679,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.Sku | Sku}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Sku|Sku}. 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/cloud_channel_service.list_skus.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListSkus_async @@ -7821,14 +7745,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.Offer | Offer}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.Offer|Offer}. * 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 `listOffersAsync()` * 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. */ listOffers( @@ -7929,13 +7852,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.Offer | Offer} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.Offer|Offer} 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 `listOffersAsync()` * 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. */ listOffersStream( @@ -7993,12 +7915,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.Offer | Offer}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.Offer|Offer}. 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/cloud_channel_service.list_offers.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListOffers_async @@ -8057,14 +7978,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableSku | PurchasableSku}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.PurchasableSku|PurchasableSku}. * 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 `listPurchasableSkusAsync()` * 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. */ listPurchasableSkus( @@ -8166,13 +8086,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableSku | PurchasableSku} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.PurchasableSku|PurchasableSku} 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 `listPurchasableSkusAsync()` * 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. */ listPurchasableSkusStream( @@ -8223,12 +8142,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableSku | PurchasableSku}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.PurchasableSku|PurchasableSku}. 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/cloud_channel_service.list_purchasable_skus.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListPurchasableSkus_async @@ -8287,14 +8205,13 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableOffer | PurchasableOffer}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.PurchasableOffer|PurchasableOffer}. * 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 `listPurchasableOffersAsync()` * 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. */ listPurchasableOffers( @@ -8396,13 +8313,12 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableOffer | PurchasableOffer} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.PurchasableOffer|PurchasableOffer} 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 `listPurchasableOffersAsync()` * 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. */ listPurchasableOffersStream( @@ -8453,12 +8369,11 @@ export class CloudChannelServiceClient { * @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.channel.v1.PurchasableOffer | PurchasableOffer}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.PurchasableOffer|PurchasableOffer}. 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/cloud_channel_service.list_purchasable_offers.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListPurchasableOffers_async @@ -8527,8 +8442,7 @@ export class CloudChannelServiceClient { * Note that it can affect your quota. * We recommend using `listSubscribersAsync()` * 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. */ listSubscribers( @@ -8631,8 +8545,7 @@ export class CloudChannelServiceClient { * times as needed. Note that it can affect your quota. * We recommend using `listSubscribersAsync()` * 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. */ listSubscribersStream( @@ -8679,12 +8592,11 @@ export class CloudChannelServiceClient { * @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 * string. 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/cloud_channel_service.list_subscribers.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListSubscribers_async @@ -8726,7 +8638,7 @@ export class CloudChannelServiceClient { * In this case, contact Cloud Channel support. * * Return value: - * List of {@link google.cloud.channel.v1.EntitlementChange|EntitlementChange}s. + * List of {@link protos.google.cloud.channel.v1.EntitlementChange|EntitlementChange}s. * * @param {Object} request * The request object that will be sent. @@ -8744,25 +8656,24 @@ export class CloudChannelServiceClient { * above 50. * @param {string} [request.pageToken] * Optional. A page token, received from a previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filters applied to the list results. * @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.channel.v1.EntitlementChange | EntitlementChange}. + * The first element of the array is Array of {@link protos.google.cloud.channel.v1.EntitlementChange|EntitlementChange}. * 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 `listEntitlementChangesAsync()` * 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. */ listEntitlementChanges( @@ -8862,24 +8773,23 @@ export class CloudChannelServiceClient { * above 50. * @param {string} [request.pageToken] * Optional. A page token, received from a previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filters applied to the list results. * @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.channel.v1.EntitlementChange | EntitlementChange} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.channel.v1.EntitlementChange|EntitlementChange} 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 `listEntitlementChangesAsync()` * 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. */ listEntitlementChangesStream( @@ -8924,23 +8834,22 @@ export class CloudChannelServiceClient { * above 50. * @param {string} [request.pageToken] * Optional. A page token, received from a previous - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to - * {@link google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} + * {@link protos.google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges|CloudChannelService.ListEntitlementChanges} * must match the call that provided the page token. * @param {string} [request.filter] * Optional. Filters applied to the list results. * @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.channel.v1.EntitlementChange | EntitlementChange}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.channel.v1.EntitlementChange|EntitlementChange}. 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/cloud_channel_service.list_entitlement_changes.js * region_tag:cloudchannel_v1_generated_CloudChannelService_ListEntitlementChanges_async diff --git a/packages/google-cloud-clouddms/package.json b/packages/google-cloud-clouddms/package.json index 4d78fe24da5..07f9ea90f1a 100644 --- a/packages/google-cloud-clouddms/package.json +++ b/packages/google-cloud-clouddms/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", @@ -46,15 +46,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", @@ -65,7 +66,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-clouddms/samples/generated/v1/data_migration_service.import_mapping_rules.js b/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.import_mapping_rules.js index 3f36ebaa657..c6921989f41 100644 --- a/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.import_mapping_rules.js +++ b/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.import_mapping_rules.js @@ -41,7 +41,7 @@ function main(parent) { /** * One or more rules files. */ - // const rulesFiles = 1234 + // const rulesFiles = [1,2,3,4] /** * Should the conversion workspace be committed automatically after the * import operation. diff --git a/packages/google-cloud-clouddms/samples/generated/v1/snippet_metadata_google.cloud.clouddms.v1.json b/packages/google-cloud-clouddms/samples/generated/v1/snippet_metadata_google.cloud.clouddms.v1.json new file mode 100644 index 00000000000..45bd0519799 --- /dev/null +++ b/packages/google-cloud-clouddms/samples/generated/v1/snippet_metadata_google.cloud.clouddms.v1.json @@ -0,0 +1,1739 @@ +{ + "clientLibrary": { + "name": "nodejs-clouddms", + "version": "2.3.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.clouddms.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async", + "title": "DataMigrationService listMigrationJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists migration jobs in a given project and location.", + "canonical": true, + "file": "data_migration_service.list_migration_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListMigrationJobs", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListMigrationJobs", + "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.clouddms.v1.ListMigrationJobsResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ListMigrationJobs", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListMigrationJobs", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_GetMigrationJob_async", + "title": "DataMigrationService getMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single migration job.", + "canonical": true, + "file": "data_migration_service.get_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.MigrationJob", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "GetMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async", + "title": "DataMigrationService createMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Creates a new migration job in a given project and location.", + "canonical": true, + "file": "data_migration_service.create_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateMigrationJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "migration_job_id", + "type": "TYPE_STRING" + }, + { + "name": "migration_job", + "type": ".google.cloud.clouddms.v1.MigrationJob" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "CreateMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async", + "title": "DataMigrationService updateMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single migration job.", + "canonical": true, + "file": "data_migration_service.update_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateMigrationJob", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "migration_job", + "type": ".google.cloud.clouddms.v1.MigrationJob" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "UpdateMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async", + "title": "DataMigrationService deleteMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single migration job.", + "canonical": true, + "file": "data_migration_service.delete_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DeleteMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_StartMigrationJob_async", + "title": "DataMigrationService startMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Start an already created migration job.", + "canonical": true, + "file": "data_migration_service.start_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StartMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.StartMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "StartMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.StartMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_StopMigrationJob_async", + "title": "DataMigrationService stopMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Stops a running migration job.", + "canonical": true, + "file": "data_migration_service.stop_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StopMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.StopMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "StopMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.StopMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async", + "title": "DataMigrationService resumeMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).", + "canonical": true, + "file": "data_migration_service.resume_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ResumeMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ResumeMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ResumeMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async", + "title": "DataMigrationService promoteMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.", + "canonical": true, + "file": "data_migration_service.promote_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PromoteMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.PromoteMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "PromoteMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.PromoteMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async", + "title": "DataMigrationService verifyMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.", + "canonical": true, + "file": "data_migration_service.verify_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "VerifyMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.VerifyMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "VerifyMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.VerifyMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async", + "title": "DataMigrationService restartMigrationJob Sample", + "origin": "API_DEFINITION", + "description": " Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.", + "canonical": true, + "file": "data_migration_service.restart_migration_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.RestartMigrationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "RestartMigrationJob", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.RestartMigrationJob", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_GenerateSshScript_async", + "title": "DataMigrationService generateSshScript Sample", + "origin": "API_DEFINITION", + "description": " Generate a SSH configuration script to configure the reverse SSH connectivity.", + "canonical": true, + "file": "data_migration_service.generate_ssh_script.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GenerateSshScript", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GenerateSshScript", + "async": true, + "parameters": [ + { + "name": "migration_job", + "type": "TYPE_STRING" + }, + { + "name": "vm", + "type": "TYPE_STRING" + }, + { + "name": "vm_creation_config", + "type": ".google.cloud.clouddms.v1.VmCreationConfig" + }, + { + "name": "vm_selection_config", + "type": ".google.cloud.clouddms.v1.VmSelectionConfig" + }, + { + "name": "vm_port", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.clouddms.v1.SshScript", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "GenerateSshScript", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GenerateSshScript", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async", + "title": "DataMigrationService listConnectionProfiles Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of all connection profiles in a given project and location.", + "canonical": true, + "file": "data_migration_service.list_connection_profiles.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 85, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConnectionProfiles", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListConnectionProfiles", + "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.clouddms.v1.ListConnectionProfilesResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ListConnectionProfiles", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListConnectionProfiles", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async", + "title": "DataMigrationService getConnectionProfile Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single connection profile.", + "canonical": true, + "file": "data_migration_service.get_connection_profile.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetConnectionProfile", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.ConnectionProfile", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "GetConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetConnectionProfile", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async", + "title": "DataMigrationService createConnectionProfile Sample", + "origin": "API_DEFINITION", + "description": " Creates a new connection profile in a given project and location.", + "canonical": true, + "file": "data_migration_service.create_connection_profile.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 84, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateConnectionProfile", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "connection_profile_id", + "type": "TYPE_STRING" + }, + { + "name": "connection_profile", + "type": ".google.cloud.clouddms.v1.ConnectionProfile" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "skip_validation", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "CreateConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateConnectionProfile", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async", + "title": "DataMigrationService updateConnectionProfile Sample", + "origin": "API_DEFINITION", + "description": " Update the configuration of a single connection profile.", + "canonical": true, + "file": "data_migration_service.update_connection_profile.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateConnectionProfile", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "connection_profile", + "type": ".google.cloud.clouddms.v1.ConnectionProfile" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "validate_only", + "type": "TYPE_BOOL" + }, + { + "name": "skip_validation", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "UpdateConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateConnectionProfile", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async", + "title": "DataMigrationService deleteConnectionProfile Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.", + "canonical": true, + "file": "data_migration_service.delete_connection_profile.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteConnectionProfile", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DeleteConnectionProfile", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteConnectionProfile", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async", + "title": "DataMigrationService createPrivateConnection Sample", + "origin": "API_DEFINITION", + "description": " Creates a new private connection in a given project and location.", + "canonical": true, + "file": "data_migration_service.create_private_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreatePrivateConnection", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "private_connection_id", + "type": "TYPE_STRING" + }, + { + "name": "private_connection", + "type": ".google.cloud.clouddms.v1.PrivateConnection" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + }, + { + "name": "skip_validation", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "CreatePrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreatePrivateConnection", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_GetPrivateConnection_async", + "title": "DataMigrationService getPrivateConnection Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single private connection.", + "canonical": true, + "file": "data_migration_service.get_private_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetPrivateConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.PrivateConnection", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "GetPrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetPrivateConnection", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ListPrivateConnections_async", + "title": "DataMigrationService listPrivateConnections Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of private connections in a given project and location.", + "canonical": true, + "file": "data_migration_service.list_private_connections.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 82, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPrivateConnections", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListPrivateConnections", + "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.clouddms.v1.ListPrivateConnectionsResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ListPrivateConnections", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListPrivateConnections", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async", + "title": "DataMigrationService deletePrivateConnection Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Database Migration Service private connection.", + "canonical": true, + "file": "data_migration_service.delete_private_connection.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeletePrivateConnection", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DeletePrivateConnection", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeletePrivateConnection", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_GetConversionWorkspace_async", + "title": "DataMigrationService getConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single conversion workspace.", + "canonical": true, + "file": "data_migration_service.get_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.ConversionWorkspace", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "GetConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.GetConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ListConversionWorkspaces_async", + "title": "DataMigrationService listConversionWorkspaces Sample", + "origin": "API_DEFINITION", + "description": " Lists conversion workspaces in a given project and location.", + "canonical": true, + "file": "data_migration_service.list_conversion_workspaces.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConversionWorkspaces", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListConversionWorkspaces", + "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.clouddms.v1.ListConversionWorkspacesResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ListConversionWorkspaces", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ListConversionWorkspaces", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async", + "title": "DataMigrationService createConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Creates a new conversion workspace in a given project and location.", + "canonical": true, + "file": "data_migration_service.create_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "conversion_workspace_id", + "type": "TYPE_STRING" + }, + { + "name": "conversion_workspace", + "type": ".google.cloud.clouddms.v1.ConversionWorkspace" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "CreateConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CreateConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async", + "title": "DataMigrationService updateConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Updates the parameters of a single conversion workspace.", + "canonical": true, + "file": "data_migration_service.update_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "conversion_workspace", + "type": ".google.cloud.clouddms.v1.ConversionWorkspace" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "UpdateConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.UpdateConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async", + "title": "DataMigrationService deleteConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single conversion workspace.", + "canonical": true, + "file": "data_migration_service.delete_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DeleteConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DeleteConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async", + "title": "DataMigrationService seedConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Imports a snapshot of the source database into the conversion workspace.", + "canonical": true, + "file": "data_migration_service.seed_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SeedConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.SeedConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "auto_commit", + "type": "TYPE_BOOL" + }, + { + "name": "source_connection_profile", + "type": "TYPE_STRING" + }, + { + "name": "destination_connection_profile", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "SeedConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.SeedConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ImportMappingRules_async", + "title": "DataMigrationService importMappingRules Sample", + "origin": "API_DEFINITION", + "description": " Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.", + "canonical": true, + "file": "data_migration_service.import_mapping_rules.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportMappingRules", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ImportMappingRules", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "rules_format", + "type": ".google.cloud.clouddms.v1.ImportRulesFileFormat" + }, + { + "name": "rules_files", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "auto_commit", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ImportMappingRules", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ImportMappingRules", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async", + "title": "DataMigrationService convertConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Creates a draft tree schema for the destination database.", + "canonical": true, + "file": "data_migration_service.convert_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ConvertConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ConvertConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "auto_commit", + "type": "TYPE_BOOL" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ConvertConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ConvertConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async", + "title": "DataMigrationService commitConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Marks all the data in the conversion workspace as committed.", + "canonical": true, + "file": "data_migration_service.commit_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CommitConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CommitConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "commit_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "CommitConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.CommitConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async", + "title": "DataMigrationService rollbackConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Rolls back a conversion workspace to the last committed snapshot.", + "canonical": true, + "file": "data_migration_service.rollback_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RollbackConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.RollbackConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "RollbackConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.RollbackConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async", + "title": "DataMigrationService applyConversionWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Applies draft tree onto a specific destination database.", + "canonical": true, + "file": "data_migration_service.apply_conversion_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ApplyConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ApplyConversionWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "connection_profile", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "ApplyConversionWorkspace", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.ApplyConversionWorkspace", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DescribeDatabaseEntities_async", + "title": "DataMigrationService describeDatabaseEntities Sample", + "origin": "API_DEFINITION", + "description": " Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.", + "canonical": true, + "file": "data_migration_service.describe_database_entities.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DescribeDatabaseEntities", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DescribeDatabaseEntities", + "async": true, + "parameters": [ + { + "name": "conversion_workspace", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "tree", + "type": ".google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType" + }, + { + "name": "uncommitted", + "type": "TYPE_BOOL" + }, + { + "name": "commit_id", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.DescribeDatabaseEntitiesResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DescribeDatabaseEntities", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DescribeDatabaseEntities", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_SearchBackgroundJobs_async", + "title": "DataMigrationService searchBackgroundJobs Sample", + "origin": "API_DEFINITION", + "description": " Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.", + "canonical": true, + "file": "data_migration_service.search_background_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchBackgroundJobs", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.SearchBackgroundJobs", + "async": true, + "parameters": [ + { + "name": "conversion_workspace", + "type": "TYPE_STRING" + }, + { + "name": "return_most_recent_per_job_type", + "type": "TYPE_BOOL" + }, + { + "name": "max_size", + "type": "TYPE_INT32" + }, + { + "name": "completed_until_time", + "type": ".google.protobuf.Timestamp" + } + ], + "resultType": ".google.cloud.clouddms.v1.SearchBackgroundJobsResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "SearchBackgroundJobs", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.SearchBackgroundJobs", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_DescribeConversionWorkspaceRevisions_async", + "title": "DataMigrationService describeConversionWorkspaceRevisions Sample", + "origin": "API_DEFINITION", + "description": " Retrieves a list of committed revisions of a specific conversion workspace.", + "canonical": true, + "file": "data_migration_service.describe_conversion_workspace_revisions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DescribeConversionWorkspaceRevisions", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DescribeConversionWorkspaceRevisions", + "async": true, + "parameters": [ + { + "name": "conversion_workspace", + "type": "TYPE_STRING" + }, + { + "name": "commit_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "DescribeConversionWorkspaceRevisions", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.DescribeConversionWorkspaceRevisions", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + }, + { + "regionTag": "datamigration_v1_generated_DataMigrationService_FetchStaticIps_async", + "title": "DataMigrationService fetchStaticIps Sample", + "origin": "API_DEFINITION", + "description": " Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.", + "canonical": true, + "file": "data_migration_service.fetch_static_ips.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchStaticIps", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.FetchStaticIps", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.clouddms.v1.FetchStaticIpsResponse", + "client": { + "shortName": "DataMigrationServiceClient", + "fullName": "google.cloud.clouddms.v1.DataMigrationServiceClient" + }, + "method": { + "shortName": "FetchStaticIps", + "fullName": "google.cloud.clouddms.v1.DataMigrationService.FetchStaticIps", + "service": { + "shortName": "DataMigrationService", + "fullName": "google.cloud.clouddms.v1.DataMigrationService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-clouddms/samples/package.json b/packages/google-cloud-clouddms/samples/package.json index dd1ee1d1b63..1c2310e3811 100644 --- a/packages/google-cloud-clouddms/samples/package.json +++ b/packages/google-cloud-clouddms/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-clouddms/src/v1/data_migration_service_client.ts b/packages/google-cloud-clouddms/src/v1/data_migration_service_client.ts index 828c19396e0..41c67ecb77a 100644 --- a/packages/google-cloud-clouddms/src/v1/data_migration_service_client.ts +++ b/packages/google-cloud-clouddms/src/v1/data_migration_service_client.ts @@ -834,9 +834,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.MigrationJob | MigrationJob}. - * 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.clouddms.v1.MigrationJob|MigrationJob}. + * 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/data_migration_service.get_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_GetMigrationJob_async @@ -934,9 +933,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.SshScript | SshScript}. - * 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.clouddms.v1.SshScript|SshScript}. + * 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/data_migration_service.generate_ssh_script.js * region_tag:datamigration_v1_generated_DataMigrationService_GenerateSshScript_async @@ -1025,9 +1023,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConnectionProfile | ConnectionProfile}. - * 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.clouddms.v1.ConnectionProfile|ConnectionProfile}. + * 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/data_migration_service.get_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_GetConnectionProfile_async @@ -1116,9 +1113,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.PrivateConnection | PrivateConnection}. - * 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.clouddms.v1.PrivateConnection|PrivateConnection}. + * 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/data_migration_service.get_private_connection.js * region_tag:datamigration_v1_generated_DataMigrationService_GetPrivateConnection_async @@ -1207,9 +1203,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConversionWorkspace | ConversionWorkspace}. - * 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.clouddms.v1.ConversionWorkspace|ConversionWorkspace}. + * 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/data_migration_service.get_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_GetConversionWorkspace_async @@ -1325,9 +1320,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.SearchBackgroundJobsResponse | SearchBackgroundJobsResponse}. - * 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.clouddms.v1.SearchBackgroundJobsResponse|SearchBackgroundJobsResponse}. + * 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/data_migration_service.search_background_jobs.js * region_tag:datamigration_v1_generated_DataMigrationService_SearchBackgroundJobs_async @@ -1421,9 +1415,8 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse | DescribeConversionWorkspaceRevisionsResponse}. - * 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.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse|DescribeConversionWorkspaceRevisionsResponse}. + * 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/data_migration_service.describe_conversion_workspace_revisions.js * region_tag:datamigration_v1_generated_DataMigrationService_DescribeConversionWorkspaceRevisions_async @@ -1540,8 +1533,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async @@ -1636,8 +1628,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateMigrationJob_async @@ -1689,8 +1680,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async @@ -1785,8 +1775,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateMigrationJob_async @@ -1839,8 +1828,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async @@ -1935,8 +1923,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteMigrationJob_async @@ -1977,8 +1964,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.start_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async @@ -2073,8 +2059,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.start_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_StartMigrationJob_async @@ -2115,8 +2100,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.stop_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async @@ -2211,8 +2195,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.stop_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_StopMigrationJob_async @@ -2254,8 +2237,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.resume_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async @@ -2350,8 +2332,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.resume_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_ResumeMigrationJob_async @@ -2393,8 +2374,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.promote_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async @@ -2489,8 +2469,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.promote_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_PromoteMigrationJob_async @@ -2532,8 +2511,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.verify_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async @@ -2628,8 +2606,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.verify_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_VerifyMigrationJob_async @@ -2672,8 +2649,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.restart_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async @@ -2768,8 +2744,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.restart_migration_job.js * region_tag:datamigration_v1_generated_DataMigrationService_RestartMigrationJob_async @@ -2830,8 +2805,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async @@ -2930,8 +2904,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateConnectionProfile_async @@ -2991,8 +2964,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async @@ -3091,8 +3063,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConnectionProfile_async @@ -3146,8 +3117,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async @@ -3246,8 +3216,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_connection_profile.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConnectionProfile_async @@ -3302,8 +3271,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_private_connection.js * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async @@ -3402,8 +3370,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_private_connection.js * region_tag:datamigration_v1_generated_DataMigrationService_CreatePrivateConnection_async @@ -3452,8 +3419,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_private_connection.js * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async @@ -3552,8 +3518,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_private_connection.js * region_tag:datamigration_v1_generated_DataMigrationService_DeletePrivateConnection_async @@ -3606,8 +3571,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async @@ -3706,8 +3670,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.create_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_CreateConversionWorkspace_async @@ -3759,8 +3722,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async @@ -3859,8 +3821,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.update_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_UpdateConversionWorkspace_async @@ -3909,8 +3870,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async @@ -4009,8 +3969,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.delete_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_DeleteConversionWorkspace_async @@ -4061,8 +4020,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.seed_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async @@ -4161,8 +4119,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.seed_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_SeedConversionWorkspace_async @@ -4213,8 +4170,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.import_mapping_rules.js * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async @@ -4309,8 +4265,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.import_mapping_rules.js * region_tag:datamigration_v1_generated_DataMigrationService_ImportMappingRules_async @@ -4358,8 +4313,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.convert_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async @@ -4458,8 +4412,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.convert_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_ConvertConversionWorkspace_async @@ -4502,8 +4455,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.commit_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async @@ -4602,8 +4554,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.commit_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_CommitConversionWorkspace_async @@ -4644,8 +4595,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.rollback_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async @@ -4744,8 +4694,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.rollback_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_RollbackConversionWorkspace_async @@ -4793,8 +4742,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.apply_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async @@ -4893,8 +4841,7 @@ export class DataMigrationServiceClient { * 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/data_migration_service.apply_conversion_workspace.js * region_tag:datamigration_v1_generated_DataMigrationService_ApplyConversionWorkspace_async @@ -4956,14 +4903,13 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.MigrationJob | MigrationJob}. + * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}. * 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 `listMigrationJobsAsync()` * 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. */ listMigrationJobs( @@ -5074,13 +5020,12 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.MigrationJob | MigrationJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob} 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 `listMigrationJobsAsync()` * 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. */ listMigrationJobsStream( @@ -5140,12 +5085,11 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.MigrationJob | MigrationJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.clouddms.v1.MigrationJob|MigrationJob}. 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/data_migration_service.list_migration_jobs.js * region_tag:datamigration_v1_generated_DataMigrationService_ListMigrationJobs_async @@ -5205,14 +5149,13 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConnectionProfile | ConnectionProfile}. + * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}. * 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 `listConnectionProfilesAsync()` * 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. */ listConnectionProfiles( @@ -5326,13 +5269,12 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConnectionProfile | ConnectionProfile} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile} 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 `listConnectionProfilesAsync()` * 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. */ listConnectionProfilesStream( @@ -5391,12 +5333,11 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConnectionProfile | ConnectionProfile}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.clouddms.v1.ConnectionProfile|ConnectionProfile}. 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/data_migration_service.list_connection_profiles.js * region_tag:datamigration_v1_generated_DataMigrationService_ListConnectionProfiles_async @@ -5452,14 +5393,13 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.PrivateConnection | PrivateConnection}. + * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}. * 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 `listPrivateConnectionsAsync()` * 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. */ listPrivateConnections( @@ -5570,13 +5510,12 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.PrivateConnection | PrivateConnection} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection} 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 `listPrivateConnectionsAsync()` * 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. */ listPrivateConnectionsStream( @@ -5632,12 +5571,11 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.PrivateConnection | PrivateConnection}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.clouddms.v1.PrivateConnection|PrivateConnection}. 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/data_migration_service.list_private_connections.js * region_tag:datamigration_v1_generated_DataMigrationService_ListPrivateConnections_async @@ -5692,14 +5630,13 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConversionWorkspace | ConversionWorkspace}. + * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}. * 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 `listConversionWorkspacesAsync()` * 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. */ listConversionWorkspaces( @@ -5809,13 +5746,12 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConversionWorkspace | ConversionWorkspace} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace} 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 `listConversionWorkspacesAsync()` * 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. */ listConversionWorkspacesStream( @@ -5870,12 +5806,11 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.ConversionWorkspace | ConversionWorkspace}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.clouddms.v1.ConversionWorkspace|ConversionWorkspace}. 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/data_migration_service.list_conversion_workspaces.js * region_tag:datamigration_v1_generated_DataMigrationService_ListConversionWorkspaces_async @@ -5938,14 +5873,13 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.DatabaseEntity | DatabaseEntity}. + * The first element of the array is Array of {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}. * 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 `describeDatabaseEntitiesAsync()` * 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. */ describeDatabaseEntities( @@ -6058,13 +5992,12 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.DatabaseEntity | DatabaseEntity} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity} 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 `describeDatabaseEntitiesAsync()` * 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. */ describeDatabaseEntitiesStream( @@ -6122,12 +6055,11 @@ export class DataMigrationServiceClient { * @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.clouddms.v1.DatabaseEntity | DatabaseEntity}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.clouddms.v1.DatabaseEntity|DatabaseEntity}. 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/data_migration_service.describe_database_entities.js * region_tag:datamigration_v1_generated_DataMigrationService_DescribeDatabaseEntities_async @@ -6175,8 +6107,7 @@ export class DataMigrationServiceClient { * Note that it can affect your quota. * We recommend using `fetchStaticIpsAsync()` * 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. */ fetchStaticIps( @@ -6273,8 +6204,7 @@ export class DataMigrationServiceClient { * times as needed. Note that it can affect your quota. * We recommend using `fetchStaticIpsAsync()` * 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. */ fetchStaticIpsStream( @@ -6315,12 +6245,11 @@ export class DataMigrationServiceClient { * @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 * string. 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/data_migration_service.fetch_static_ips.js * region_tag:datamigration_v1_generated_DataMigrationService_FetchStaticIps_async @@ -6385,7 +6314,7 @@ export class DataMigrationServiceClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -6406,8 +6335,7 @@ export class DataMigrationServiceClient { * @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. @@ -6433,7 +6361,7 @@ export class DataMigrationServiceClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -6454,8 +6382,7 @@ export class DataMigrationServiceClient { * @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. @@ -6482,7 +6409,7 @@ export class DataMigrationServiceClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -6497,8 +6424,7 @@ export class DataMigrationServiceClient { * 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 * ``` @@ -6544,12 +6470,11 @@ export class DataMigrationServiceClient { * @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-contactcenterinsights/package.json b/packages/google-cloud-contactcenterinsights/package.json index 508b1c8ac71..2b01e0bd1be 100644 --- a/packages/google-cloud-contactcenterinsights/package.json +++ b/packages/google-cloud-contactcenterinsights/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-contactcenterinsights" } diff --git a/packages/google-cloud-contactcenterinsights/samples/generated/v1/snippet_metadata_google.cloud.contactcenterinsights.v1.json b/packages/google-cloud-contactcenterinsights/samples/generated/v1/snippet_metadata_google.cloud.contactcenterinsights.v1.json new file mode 100644 index 00000000000..cf302d19938 --- /dev/null +++ b/packages/google-cloud-contactcenterinsights/samples/generated/v1/snippet_metadata_google.cloud.contactcenterinsights.v1.json @@ -0,0 +1,1695 @@ +{ + "clientLibrary": { + "name": "nodejs-contactcenterinsights", + "version": "2.9.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.contactcenterinsights.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CreateConversation_async", + "title": "ContactCenterInsights createConversation Sample", + "origin": "API_DEFINITION", + "description": " Creates a conversation.", + "canonical": true, + "file": "contact_center_insights.create_conversation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateConversation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "conversation", + "type": ".google.cloud.contactcenterinsights.v1.Conversation" + }, + { + "name": "conversation_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Conversation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CreateConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateConversation", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UploadConversation_async", + "title": "ContactCenterInsights uploadConversation Sample", + "origin": "API_DEFINITION", + "description": " Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.", + "canonical": true, + "file": "contact_center_insights.upload_conversation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UploadConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UploadConversation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "conversation", + "type": ".google.cloud.contactcenterinsights.v1.Conversation" + }, + { + "name": "conversation_id", + "type": "TYPE_STRING" + }, + { + "name": "redaction_config", + "type": ".google.cloud.contactcenterinsights.v1.RedactionConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UploadConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UploadConversation", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdateConversation_async", + "title": "ContactCenterInsights updateConversation Sample", + "origin": "API_DEFINITION", + "description": " Updates a conversation.", + "canonical": true, + "file": "contact_center_insights.update_conversation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateConversation", + "async": true, + "parameters": [ + { + "name": "conversation", + "type": ".google.cloud.contactcenterinsights.v1.Conversation" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Conversation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdateConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateConversation", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetConversation_async", + "title": "ContactCenterInsights getConversation Sample", + "origin": "API_DEFINITION", + "description": " Gets a conversation.", + "canonical": true, + "file": "contact_center_insights.get_conversation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetConversation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.contactcenterinsights.v1.ConversationView" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Conversation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetConversation", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListConversations_async", + "title": "ContactCenterInsights listConversations Sample", + "origin": "API_DEFINITION", + "description": " Lists conversations.", + "canonical": true, + "file": "contact_center_insights.list_conversations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListConversations", + "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": "view", + "type": ".google.cloud.contactcenterinsights.v1.ConversationView" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.ListConversationsResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListConversations", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeleteConversation_async", + "title": "ContactCenterInsights deleteConversation Sample", + "origin": "API_DEFINITION", + "description": " Deletes a conversation.", + "canonical": true, + "file": "contact_center_insights.delete_conversation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteConversation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeleteConversation", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteConversation", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CreateAnalysis_async", + "title": "ContactCenterInsights createAnalysis Sample", + "origin": "API_DEFINITION", + "description": " Creates an analysis. The long running operation is done when the analysis has completed.", + "canonical": true, + "file": "contact_center_insights.create_analysis.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateAnalysis", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "analysis", + "type": ".google.cloud.contactcenterinsights.v1.Analysis" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CreateAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateAnalysis", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetAnalysis_async", + "title": "ContactCenterInsights getAnalysis Sample", + "origin": "API_DEFINITION", + "description": " Gets an analysis.", + "canonical": true, + "file": "contact_center_insights.get_analysis.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetAnalysis", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Analysis", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetAnalysis", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListAnalyses_async", + "title": "ContactCenterInsights listAnalyses Sample", + "origin": "API_DEFINITION", + "description": " Lists analyses.", + "canonical": true, + "file": "contact_center_insights.list_analyses.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnalyses", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListAnalyses", + "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.contactcenterinsights.v1.ListAnalysesResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListAnalyses", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListAnalyses", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeleteAnalysis_async", + "title": "ContactCenterInsights deleteAnalysis Sample", + "origin": "API_DEFINITION", + "description": " Deletes an analysis.", + "canonical": true, + "file": "contact_center_insights.delete_analysis.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteAnalysis", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeleteAnalysis", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteAnalysis", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_BulkAnalyzeConversations_async", + "title": "ContactCenterInsights bulkAnalyzeConversations Sample", + "origin": "API_DEFINITION", + "description": " Analyzes multiple conversations in a single request.", + "canonical": true, + "file": "contact_center_insights.bulk_analyze_conversations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BulkAnalyzeConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.BulkAnalyzeConversations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "analysis_percentage", + "type": "TYPE_FLOAT" + }, + { + "name": "annotator_selector", + "type": ".google.cloud.contactcenterinsights.v1.AnnotatorSelector" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "BulkAnalyzeConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.BulkAnalyzeConversations", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_IngestConversations_async", + "title": "ContactCenterInsights ingestConversations Sample", + "origin": "API_DEFINITION", + "description": " Imports conversations and processes them according to the user's configuration.", + "canonical": true, + "file": "contact_center_insights.ingest_conversations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "IngestConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.IngestConversations", + "async": true, + "parameters": [ + { + "name": "gcs_source", + "type": ".google.cloud.contactcenterinsights.v1.IngestConversationsRequest.GcsSource" + }, + { + "name": "transcript_object_config", + "type": ".google.cloud.contactcenterinsights.v1.IngestConversationsRequest.TranscriptObjectConfig" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "conversation_config", + "type": ".google.cloud.contactcenterinsights.v1.IngestConversationsRequest.ConversationConfig" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "IngestConversations", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.IngestConversations", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ExportInsightsData_async", + "title": "ContactCenterInsights exportInsightsData Sample", + "origin": "API_DEFINITION", + "description": " Export insights data to a destination defined in the request body.", + "canonical": true, + "file": "contact_center_insights.export_insights_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportInsightsData", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ExportInsightsData", + "async": true, + "parameters": [ + { + "name": "big_query_destination", + "type": ".google.cloud.contactcenterinsights.v1.ExportInsightsDataRequest.BigQueryDestination" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "kms_key", + "type": "TYPE_STRING" + }, + { + "name": "write_disposition", + "type": ".google.cloud.contactcenterinsights.v1.ExportInsightsDataRequest.WriteDisposition" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ExportInsightsData", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ExportInsightsData", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CreateIssueModel_async", + "title": "ContactCenterInsights createIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Creates an issue model.", + "canonical": true, + "file": "contact_center_insights.create_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateIssueModel", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "issue_model", + "type": ".google.cloud.contactcenterinsights.v1.IssueModel" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CreateIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdateIssueModel_async", + "title": "ContactCenterInsights updateIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Updates an issue model.", + "canonical": true, + "file": "contact_center_insights.update_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateIssueModel", + "async": true, + "parameters": [ + { + "name": "issue_model", + "type": ".google.cloud.contactcenterinsights.v1.IssueModel" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.IssueModel", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdateIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetIssueModel_async", + "title": "ContactCenterInsights getIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Gets an issue model.", + "canonical": true, + "file": "contact_center_insights.get_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetIssueModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.IssueModel", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListIssueModels_async", + "title": "ContactCenterInsights listIssueModels Sample", + "origin": "API_DEFINITION", + "description": " Lists issue models.", + "canonical": true, + "file": "contact_center_insights.list_issue_models.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIssueModels", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListIssueModels", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.ListIssueModelsResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListIssueModels", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListIssueModels", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeleteIssueModel_async", + "title": "ContactCenterInsights deleteIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Deletes an issue model.", + "canonical": true, + "file": "contact_center_insights.delete_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssueModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeleteIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeployIssueModel_async", + "title": "ContactCenterInsights deployIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.", + "canonical": true, + "file": "contact_center_insights.deploy_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeployIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeployIssueModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeployIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeployIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UndeployIssueModel_async", + "title": "ContactCenterInsights undeployIssueModel Sample", + "origin": "API_DEFINITION", + "description": " Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.", + "canonical": true, + "file": "contact_center_insights.undeploy_issue_model.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UndeployIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UndeployIssueModel", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UndeployIssueModel", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UndeployIssueModel", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetIssue_async", + "title": "ContactCenterInsights getIssue Sample", + "origin": "API_DEFINITION", + "description": " Gets an issue.", + "canonical": true, + "file": "contact_center_insights.get_issue.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetIssue", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Issue", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetIssue", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListIssues_async", + "title": "ContactCenterInsights listIssues Sample", + "origin": "API_DEFINITION", + "description": " Lists issues.", + "canonical": true, + "file": "contact_center_insights.list_issues.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListIssues", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListIssues", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.ListIssuesResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListIssues", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListIssues", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdateIssue_async", + "title": "ContactCenterInsights updateIssue Sample", + "origin": "API_DEFINITION", + "description": " Updates an issue.", + "canonical": true, + "file": "contact_center_insights.update_issue.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateIssue", + "async": true, + "parameters": [ + { + "name": "issue", + "type": ".google.cloud.contactcenterinsights.v1.Issue" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Issue", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdateIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateIssue", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeleteIssue_async", + "title": "ContactCenterInsights deleteIssue Sample", + "origin": "API_DEFINITION", + "description": " Deletes an issue.", + "canonical": true, + "file": "contact_center_insights.delete_issue.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssue", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeleteIssue", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteIssue", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CalculateIssueModelStats_async", + "title": "ContactCenterInsights calculateIssueModelStats Sample", + "origin": "API_DEFINITION", + "description": " Gets an issue model's statistics.", + "canonical": true, + "file": "contact_center_insights.calculate_issue_model_stats.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CalculateIssueModelStats", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CalculateIssueModelStats", + "async": true, + "parameters": [ + { + "name": "issue_model", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.CalculateIssueModelStatsResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CalculateIssueModelStats", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CalculateIssueModelStats", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CreatePhraseMatcher_async", + "title": "ContactCenterInsights createPhraseMatcher Sample", + "origin": "API_DEFINITION", + "description": " Creates a phrase matcher.", + "canonical": true, + "file": "contact_center_insights.create_phrase_matcher.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreatePhraseMatcher", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "phrase_matcher", + "type": ".google.cloud.contactcenterinsights.v1.PhraseMatcher" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.PhraseMatcher", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CreatePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreatePhraseMatcher", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetPhraseMatcher_async", + "title": "ContactCenterInsights getPhraseMatcher Sample", + "origin": "API_DEFINITION", + "description": " Gets a phrase matcher.", + "canonical": true, + "file": "contact_center_insights.get_phrase_matcher.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetPhraseMatcher", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.PhraseMatcher", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetPhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetPhraseMatcher", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListPhraseMatchers_async", + "title": "ContactCenterInsights listPhraseMatchers Sample", + "origin": "API_DEFINITION", + "description": " Lists phrase matchers.", + "canonical": true, + "file": "contact_center_insights.list_phrase_matchers.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPhraseMatchers", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListPhraseMatchers", + "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.contactcenterinsights.v1.ListPhraseMatchersResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListPhraseMatchers", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListPhraseMatchers", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeletePhraseMatcher_async", + "title": "ContactCenterInsights deletePhraseMatcher Sample", + "origin": "API_DEFINITION", + "description": " Deletes a phrase matcher.", + "canonical": true, + "file": "contact_center_insights.delete_phrase_matcher.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeletePhraseMatcher", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeletePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeletePhraseMatcher", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdatePhraseMatcher_async", + "title": "ContactCenterInsights updatePhraseMatcher Sample", + "origin": "API_DEFINITION", + "description": " Updates a phrase matcher.", + "canonical": true, + "file": "contact_center_insights.update_phrase_matcher.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdatePhraseMatcher", + "async": true, + "parameters": [ + { + "name": "phrase_matcher", + "type": ".google.cloud.contactcenterinsights.v1.PhraseMatcher" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.PhraseMatcher", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdatePhraseMatcher", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdatePhraseMatcher", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CalculateStats_async", + "title": "ContactCenterInsights calculateStats Sample", + "origin": "API_DEFINITION", + "description": " Gets conversation statistics.", + "canonical": true, + "file": "contact_center_insights.calculate_stats.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CalculateStats", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CalculateStats", + "async": true, + "parameters": [ + { + "name": "location", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.CalculateStatsResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CalculateStats", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CalculateStats", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetSettings_async", + "title": "ContactCenterInsights getSettings Sample", + "origin": "API_DEFINITION", + "description": " Gets project-level settings.", + "canonical": true, + "file": "contact_center_insights.get_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSettings", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetSettings", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Settings", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetSettings", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetSettings", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdateSettings_async", + "title": "ContactCenterInsights updateSettings Sample", + "origin": "API_DEFINITION", + "description": " Updates project-level settings.", + "canonical": true, + "file": "contact_center_insights.update_settings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSettings", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateSettings", + "async": true, + "parameters": [ + { + "name": "settings", + "type": ".google.cloud.contactcenterinsights.v1.Settings" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.Settings", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdateSettings", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateSettings", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_CreateView_async", + "title": "ContactCenterInsights createView Sample", + "origin": "API_DEFINITION", + "description": " Creates a view.", + "canonical": true, + "file": "contact_center_insights.create_view.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateView", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "view", + "type": ".google.cloud.contactcenterinsights.v1.View" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.View", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "CreateView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.CreateView", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_GetView_async", + "title": "ContactCenterInsights getView Sample", + "origin": "API_DEFINITION", + "description": " Gets a view.", + "canonical": true, + "file": "contact_center_insights.get_view.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetView", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.View", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "GetView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.GetView", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_ListViews_async", + "title": "ContactCenterInsights listViews Sample", + "origin": "API_DEFINITION", + "description": " Lists views.", + "canonical": true, + "file": "contact_center_insights.list_views.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListViews", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListViews", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.ListViewsResponse", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "ListViews", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.ListViews", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_UpdateView_async", + "title": "ContactCenterInsights updateView Sample", + "origin": "API_DEFINITION", + "description": " Updates a view.", + "canonical": true, + "file": "contact_center_insights.update_view.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateView", + "async": true, + "parameters": [ + { + "name": "view", + "type": ".google.cloud.contactcenterinsights.v1.View" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contactcenterinsights.v1.View", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "UpdateView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.UpdateView", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + }, + { + "regionTag": "contactcenterinsights_v1_generated_ContactCenterInsights_DeleteView_async", + "title": "ContactCenterInsights deleteView Sample", + "origin": "API_DEFINITION", + "description": " Deletes a view.", + "canonical": true, + "file": "contact_center_insights.delete_view.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteView", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "ContactCenterInsightsClient", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient" + }, + "method": { + "shortName": "DeleteView", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights.DeleteView", + "service": { + "shortName": "ContactCenterInsights", + "fullName": "google.cloud.contactcenterinsights.v1.ContactCenterInsights" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-contactcenterinsights/samples/package.json b/packages/google-cloud-contactcenterinsights/samples/package.json index cd759390f99..5283b1ede3d 100644 --- a/packages/google-cloud-contactcenterinsights/samples/package.json +++ b/packages/google-cloud-contactcenterinsights/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-contactcenterinsights/src/v1/contact_center_insights_client.ts b/packages/google-cloud-contactcenterinsights/src/v1/contact_center_insights_client.ts index 51e3326bf2c..b1fae3d9059 100644 --- a/packages/google-cloud-contactcenterinsights/src/v1/contact_center_insights_client.ts +++ b/packages/google-cloud-contactcenterinsights/src/v1/contact_center_insights_client.ts @@ -559,13 +559,12 @@ export class ContactCenterInsightsClient { * server-generated ID will be used. * * This value should be 4-64 characters and must match the regular - * expression `^{@link 0-9|a-z0-9-]{4,64}$`. Valid characters are `[a-z}-` + * expression `^{@link protos.0-9|a-z0-9-]{4,64}$`. Valid characters are `[a-z}-` * @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.contactcenterinsights.v1.Conversation | Conversation}. - * 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.contactcenterinsights.v1.Conversation|Conversation}. + * 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/contact_center_insights.create_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateConversation_async @@ -662,9 +661,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Conversation | Conversation}. - * 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.contactcenterinsights.v1.Conversation|Conversation}. + * 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/contact_center_insights.update_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdateConversation_async @@ -761,9 +759,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Conversation | Conversation}. - * 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.contactcenterinsights.v1.Conversation|Conversation}. + * 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/contact_center_insights.get_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetConversation_async @@ -862,9 +859,8 @@ export class ContactCenterInsightsClient { * @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/contact_center_insights.delete_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteConversation_async @@ -959,9 +955,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Analysis | Analysis}. - * 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.contactcenterinsights.v1.Analysis|Analysis}. + * 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/contact_center_insights.get_analysis.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetAnalysis_async @@ -1056,9 +1051,8 @@ export class ContactCenterInsightsClient { * @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/contact_center_insights.delete_analysis.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteAnalysis_async @@ -1155,9 +1149,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.IssueModel | IssueModel}. - * 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.contactcenterinsights.v1.IssueModel|IssueModel}. + * 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/contact_center_insights.update_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdateIssueModel_async @@ -1252,9 +1245,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.IssueModel | IssueModel}. - * 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.contactcenterinsights.v1.IssueModel|IssueModel}. + * 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/contact_center_insights.get_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetIssueModel_async @@ -1349,9 +1341,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.ListIssueModelsResponse | ListIssueModelsResponse}. - * 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.contactcenterinsights.v1.ListIssueModelsResponse|ListIssueModelsResponse}. + * 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/contact_center_insights.list_issue_models.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListIssueModels_async @@ -1446,9 +1437,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Issue | Issue}. - * 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.contactcenterinsights.v1.Issue|Issue}. + * 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/contact_center_insights.get_issue.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetIssue_async @@ -1537,9 +1527,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.ListIssuesResponse | ListIssuesResponse}. - * 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.contactcenterinsights.v1.ListIssuesResponse|ListIssuesResponse}. + * 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/contact_center_insights.list_issues.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListIssues_async @@ -1636,9 +1625,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Issue | Issue}. - * 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.contactcenterinsights.v1.Issue|Issue}. + * 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/contact_center_insights.update_issue.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdateIssue_async @@ -1733,9 +1721,8 @@ export class ContactCenterInsightsClient { * @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/contact_center_insights.delete_issue.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteIssue_async @@ -1830,9 +1817,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.CalculateIssueModelStatsResponse | CalculateIssueModelStatsResponse}. - * 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.contactcenterinsights.v1.CalculateIssueModelStatsResponse|CalculateIssueModelStatsResponse}. + * 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/contact_center_insights.calculate_issue_model_stats.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CalculateIssueModelStats_async @@ -1936,9 +1922,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher}. - * 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.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher}. + * 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/contact_center_insights.create_phrase_matcher.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreatePhraseMatcher_async @@ -2033,9 +2018,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher}. - * 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.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher}. + * 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/contact_center_insights.get_phrase_matcher.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetPhraseMatcher_async @@ -2130,9 +2114,8 @@ export class ContactCenterInsightsClient { * @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/contact_center_insights.delete_phrase_matcher.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeletePhraseMatcher_async @@ -2229,9 +2212,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher}. - * 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.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher}. + * 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/contact_center_insights.update_phrase_matcher.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdatePhraseMatcher_async @@ -2329,9 +2311,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.CalculateStatsResponse | CalculateStatsResponse}. - * 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.contactcenterinsights.v1.CalculateStatsResponse|CalculateStatsResponse}. + * 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/contact_center_insights.calculate_stats.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CalculateStats_async @@ -2426,9 +2407,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Settings | Settings}. - * 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.contactcenterinsights.v1.Settings|Settings}. + * 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/contact_center_insights.get_settings.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetSettings_async @@ -2525,9 +2505,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Settings | Settings}. - * 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.contactcenterinsights.v1.Settings|Settings}. + * 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/contact_center_insights.update_settings.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdateSettings_async @@ -2627,9 +2606,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View}. - * 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.contactcenterinsights.v1.View|View}. + * 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/contact_center_insights.create_view.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateView_async @@ -2724,9 +2702,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View}. - * 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.contactcenterinsights.v1.View|View}. + * 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/contact_center_insights.get_view.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_GetView_async @@ -2817,9 +2794,8 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View}. - * 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.contactcenterinsights.v1.View|View}. + * 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/contact_center_insights.update_view.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UpdateView_async @@ -2914,9 +2890,8 @@ export class ContactCenterInsightsClient { * @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/contact_center_insights.delete_view.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteView_async @@ -3019,7 +2994,7 @@ export class ContactCenterInsightsClient { * a server-generated ID will be used. * * This value should be 4-64 characters and must match the regular - * expression `^{@link 0-9|a-z0-9-]{4,64}$`. Valid characters are `[a-z}-` + * expression `^{@link protos.0-9|a-z0-9-]{4,64}$`. Valid characters are `[a-z}-` * @param {google.cloud.contactcenterinsights.v1.RedactionConfig} [request.redactionConfig] * Optional. DLP settings for transcript redaction. Optional, will default to * the config specified in Settings. @@ -3029,8 +3004,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.upload_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UploadConversation_async @@ -3125,8 +3099,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.upload_conversation.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UploadConversation_async @@ -3170,8 +3143,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.create_analysis.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateAnalysis_async @@ -3266,8 +3238,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.create_analysis.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateAnalysis_async @@ -3316,8 +3287,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.bulk_analyze_conversations.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_BulkAnalyzeConversations_async @@ -3416,8 +3386,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.bulk_analyze_conversations.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_BulkAnalyzeConversations_async @@ -3465,8 +3434,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.ingest_conversations.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_IngestConversations_async @@ -3561,8 +3529,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.ingest_conversations.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_IngestConversations_async @@ -3614,8 +3581,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.export_insights_data.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ExportInsightsData_async @@ -3710,8 +3676,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.export_insights_data.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ExportInsightsData_async @@ -3754,8 +3719,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.create_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateIssueModel_async @@ -3850,8 +3814,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.create_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_CreateIssueModel_async @@ -3892,8 +3855,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.delete_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteIssueModel_async @@ -3988,8 +3950,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.delete_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeleteIssueModel_async @@ -4031,8 +3992,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.deploy_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeployIssueModel_async @@ -4127,8 +4087,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.deploy_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_DeployIssueModel_async @@ -4170,8 +4129,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.undeploy_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UndeployIssueModel_async @@ -4266,8 +4224,7 @@ export class ContactCenterInsightsClient { * 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/contact_center_insights.undeploy_issue_model.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_UndeployIssueModel_async @@ -4319,14 +4276,13 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Conversation | Conversation}. + * The first element of the array is Array of {@link protos.google.cloud.contactcenterinsights.v1.Conversation|Conversation}. * 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 `listConversationsAsync()` * 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. */ listConversations( @@ -4427,13 +4383,12 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Conversation | Conversation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contactcenterinsights.v1.Conversation|Conversation} 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 `listConversationsAsync()` * 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. */ listConversationsStream( @@ -4483,12 +4438,11 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Conversation | Conversation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contactcenterinsights.v1.Conversation|Conversation}. 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/contact_center_insights.list_conversations.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListConversations_async @@ -4536,14 +4490,13 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Analysis | Analysis}. + * The first element of the array is Array of {@link protos.google.cloud.contactcenterinsights.v1.Analysis|Analysis}. * 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 `listAnalysesAsync()` * 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. */ listAnalyses( @@ -4642,13 +4595,12 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Analysis | Analysis} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contactcenterinsights.v1.Analysis|Analysis} 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 `listAnalysesAsync()` * 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. */ listAnalysesStream( @@ -4696,12 +4648,11 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.Analysis | Analysis}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contactcenterinsights.v1.Analysis|Analysis}. 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/contact_center_insights.list_analyses.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListAnalyses_async @@ -4749,14 +4700,13 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher}. + * The first element of the array is Array of {@link protos.google.cloud.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher}. * 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 `listPhraseMatchersAsync()` * 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. */ listPhraseMatchers( @@ -4855,13 +4805,12 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher} 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 `listPhraseMatchersAsync()` * 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. */ listPhraseMatchersStream( @@ -4909,12 +4858,11 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.PhraseMatcher | PhraseMatcher}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contactcenterinsights.v1.PhraseMatcher|PhraseMatcher}. 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/contact_center_insights.list_phrase_matchers.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListPhraseMatchers_async @@ -4959,14 +4907,13 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View}. + * The first element of the array is Array of {@link protos.google.cloud.contactcenterinsights.v1.View|View}. * 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 `listViewsAsync()` * 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. */ listViews( @@ -5062,13 +5009,12 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contactcenterinsights.v1.View|View} 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 `listViewsAsync()` * 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. */ listViewsStream( @@ -5113,12 +5059,11 @@ export class ContactCenterInsightsClient { * @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.contactcenterinsights.v1.View | View}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contactcenterinsights.v1.View|View}. 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/contact_center_insights.list_views.js * region_tag:contactcenterinsights_v1_generated_ContactCenterInsights_ListViews_async diff --git a/packages/google-cloud-contentwarehouse/README.md b/packages/google-cloud-contentwarehouse/README.md index 2e688e068c9..3b7ddffeb83 100644 --- a/packages/google-cloud-contentwarehouse/README.md +++ b/packages/google-cloud-contentwarehouse/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Document AI Warehouse: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Document AI Warehouse: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-contentwarehouse) [![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/contentwarehouse.svg)](https://www.npmjs.org/package/@google-cloud/contentwarehouse) @@ -110,39 +110,38 @@ callListRuleSets(); ## 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-contentwarehouse/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Document_link_service.create_document_link | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.create_document_link.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.create_document_link.js,samples/README.md) | -| Document_link_service.delete_document_link | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.delete_document_link.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.delete_document_link.js,samples/README.md) | -| Document_link_service.list_linked_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.list_linked_sources.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.list_linked_sources.js,samples/README.md) | -| Document_link_service.list_linked_targets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.list_linked_targets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.list_linked_targets.js,samples/README.md) | -| Document_schema_service.create_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.create_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.create_document_schema.js,samples/README.md) | -| Document_schema_service.delete_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.delete_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.delete_document_schema.js,samples/README.md) | -| Document_schema_service.get_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.get_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.get_document_schema.js,samples/README.md) | -| Document_schema_service.list_document_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.list_document_schemas.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.list_document_schemas.js,samples/README.md) | -| Document_schema_service.update_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.update_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.update_document_schema.js,samples/README.md) | -| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.create_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.create_document.js,samples/README.md) | -| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.delete_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.delete_document.js,samples/README.md) | -| Document_service.fetch_acl | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.fetch_acl.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.fetch_acl.js,samples/README.md) | -| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.get_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.get_document.js,samples/README.md) | -| Document_service.lock_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.lock_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.lock_document.js,samples/README.md) | -| Document_service.search_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.search_documents.js,samples/README.md) | -| Document_service.set_acl | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.set_acl.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.set_acl.js,samples/README.md) | -| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.update_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.update_document.js,samples/README.md) | -| Rule_set_service.create_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.create_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.create_rule_set.js,samples/README.md) | -| Rule_set_service.delete_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.delete_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.delete_rule_set.js,samples/README.md) | -| Rule_set_service.get_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.get_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.get_rule_set.js,samples/README.md) | -| Rule_set_service.list_rule_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.list_rule_sets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.list_rule_sets.js,samples/README.md) | -| Rule_set_service.update_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.update_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.update_rule_set.js,samples/README.md) | -| Synonym_set_service.create_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.create_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.create_synonym_set.js,samples/README.md) | -| Synonym_set_service.delete_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.delete_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.delete_synonym_set.js,samples/README.md) | -| Synonym_set_service.get_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.get_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.get_synonym_set.js,samples/README.md) | -| Synonym_set_service.list_synonym_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.list_synonym_sets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.list_synonym_sets.js,samples/README.md) | -| Synonym_set_service.update_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.update_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.update_synonym_set.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/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-contentwarehouse/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/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-contentwarehouse/samples/test/quickstart.js,samples/README.md) | +| Document_link_service.create_document_link | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.create_document_link.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.create_document_link.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_link_service.delete_document_link | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.delete_document_link.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.delete_document_link.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_link_service.list_linked_sources | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.list_linked_sources.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.list_linked_sources.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_link_service.list_linked_targets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_link_service.list_linked_targets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_link_service.list_linked_targets.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_schema_service.create_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.create_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.create_document_schema.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_schema_service.delete_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.delete_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.delete_document_schema.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_schema_service.get_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.get_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.get_document_schema.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_schema_service.list_document_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.list_document_schemas.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.list_document_schemas.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_schema_service.update_document_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_schema_service.update_document_schema.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_schema_service.update_document_schema.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.create_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.create_document.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.delete_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.delete_document.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.fetch_acl | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.fetch_acl.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.fetch_acl.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.get_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.get_document.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.lock_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.lock_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.lock_document.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.search_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.search_documents.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.set_acl | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.set_acl.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.set_acl.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.update_document.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/document_service.update_document.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Rule_set_service.create_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.create_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.create_rule_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Rule_set_service.delete_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.delete_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.delete_rule_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Rule_set_service.get_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.get_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.get_rule_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Rule_set_service.list_rule_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.list_rule_sets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.list_rule_sets.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Rule_set_service.update_rule_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/rule_set_service.update_rule_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/rule_set_service.update_rule_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Synonym_set_service.create_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.create_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.create_synonym_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Synonym_set_service.delete_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.delete_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.delete_synonym_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Synonym_set_service.get_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.get_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.get_synonym_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Synonym_set_service.list_synonym_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.list_synonym_sets.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.list_synonym_sets.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Synonym_set_service.update_synonym_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/samples/generated/v1/synonym_set_service.update_synonym_set.js) | [![Open in Cloud Shell][shell_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-contentwarehouse/samples/generated/v1/synonym_set_service.update_synonym_set.js,packages/google-cloud-contentwarehouse/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/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-contentwarehouse/samples/quickstart.js,packages/google-cloud-contentwarehouse/samples/README.md) | diff --git a/packages/google-cloud-contentwarehouse/package.json b/packages/google-cloud-contentwarehouse/package.json index 00ddc1717b2..8fda998e5a9 100644 --- a/packages/google-cloud-contentwarehouse/package.json +++ b/packages/google-cloud-contentwarehouse/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-contentwarehouse/samples/README.md b/packages/google-cloud-contentwarehouse/samples/README.md index bd3bf5baa5b..1f130a70dce 100644 --- a/packages/google-cloud-contentwarehouse/samples/README.md +++ b/packages/google-cloud-contentwarehouse/samples/README.md @@ -40,7 +40,6 @@ * [Synonym_set_service.list_synonym_sets](#synonym_set_service.list_synonym_sets) * [Synonym_set_service.update_synonym_set](#synonym_set_service.update_synonym_set) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -528,23 +527,6 @@ __Usage:__ `node packages/google-cloud-contentwarehouse/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-contentwarehouse/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-contentwarehouse/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-contentwarehouse/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js b/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js index d847d8d114d..c110aeede44 100644 --- a/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js +++ b/packages/google-cloud-contentwarehouse/samples/generated/v1/document_service.search_documents.js @@ -109,7 +109,7 @@ function main(parent) { * * For schema id, abc123, get the counts for MORTGAGE_TYPE: * count('abc123.MORTGAGE_TYPE') */ - // const histogramQueries = 1234 + // const histogramQueries = [1,2,3,4] /** * Controls if the search document request requires the return of a total size * of matched documents. See diff --git a/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata.google.cloud.contentwarehouse.v1.json b/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata.google.cloud.contentwarehouse.v1.json index e35758fc052..6a41363d6cf 100644 --- a/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata.google.cloud.contentwarehouse.v1.json +++ b/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata.google.cloud.contentwarehouse.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-contentwarehouse", - "version": "0.5.0", + "version": "0.5.1", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata_google.cloud.contentwarehouse.v1.json b/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata_google.cloud.contentwarehouse.v1.json new file mode 100644 index 00000000000..6a41363d6cf --- /dev/null +++ b/packages/google-cloud-contentwarehouse/samples/generated/v1/snippet_metadata_google.cloud.contentwarehouse.v1.json @@ -0,0 +1,1283 @@ +{ + "clientLibrary": { + "name": "nodejs-contentwarehouse", + "version": "0.5.1", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.contentwarehouse.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "contentwarehouse_v1_generated_DocumentLinkService_ListLinkedTargets_async", + "title": "DocumentLinkService listLinkedTargets Sample", + "origin": "API_DEFINITION", + "description": " Return all target document-links from the document.", + "canonical": true, + "file": "document_link_service.list_linked_targets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListLinkedTargets", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.ListLinkedTargets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.ListLinkedTargetsResponse", + "client": { + "shortName": "DocumentLinkServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkServiceClient" + }, + "method": { + "shortName": "ListLinkedTargets", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.ListLinkedTargets", + "service": { + "shortName": "DocumentLinkService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentLinkService_ListLinkedSources_async", + "title": "DocumentLinkService listLinkedSources Sample", + "origin": "API_DEFINITION", + "description": " Return all source document-links from the document.", + "canonical": true, + "file": "document_link_service.list_linked_sources.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 76, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListLinkedSources", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.ListLinkedSources", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.ListLinkedSourcesResponse", + "client": { + "shortName": "DocumentLinkServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkServiceClient" + }, + "method": { + "shortName": "ListLinkedSources", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.ListLinkedSources", + "service": { + "shortName": "DocumentLinkService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentLinkService_CreateDocumentLink_async", + "title": "DocumentLinkService createDocumentLink Sample", + "origin": "API_DEFINITION", + "description": " Create a link between a source document and a target document.", + "canonical": true, + "file": "document_link_service.create_document_link.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDocumentLink", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.CreateDocumentLink", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "document_link", + "type": ".google.cloud.contentwarehouse.v1.DocumentLink" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.DocumentLink", + "client": { + "shortName": "DocumentLinkServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkServiceClient" + }, + "method": { + "shortName": "CreateDocumentLink", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.CreateDocumentLink", + "service": { + "shortName": "DocumentLinkService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentLinkService_DeleteDocumentLink_async", + "title": "DocumentLinkService deleteDocumentLink Sample", + "origin": "API_DEFINITION", + "description": " Remove the link between the source and target documents.", + "canonical": true, + "file": "document_link_service.delete_document_link.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDocumentLink", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.DeleteDocumentLink", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DocumentLinkServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkServiceClient" + }, + "method": { + "shortName": "DeleteDocumentLink", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService.DeleteDocumentLink", + "service": { + "shortName": "DocumentLinkService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentLinkService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentSchemaService_CreateDocumentSchema_async", + "title": "DocumentLinkService createDocumentSchema Sample", + "origin": "API_DEFINITION", + "description": " Creates a document schema.", + "canonical": true, + "file": "document_schema_service.create_document_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.CreateDocumentSchema", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "document_schema", + "type": ".google.cloud.contentwarehouse.v1.DocumentSchema" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.DocumentSchema", + "client": { + "shortName": "DocumentSchemaServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaServiceClient" + }, + "method": { + "shortName": "CreateDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.CreateDocumentSchema", + "service": { + "shortName": "DocumentSchemaService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentSchemaService_UpdateDocumentSchema_async", + "title": "DocumentLinkService updateDocumentSchema Sample", + "origin": "API_DEFINITION", + "description": " Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the [EnumTypeOptions.validation_check_disabled][google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled] flag for ENUM possible values. Updating existing properties will result into INVALID_ARGUMENT.", + "canonical": true, + "file": "document_schema_service.update_document_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.UpdateDocumentSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "document_schema", + "type": ".google.cloud.contentwarehouse.v1.DocumentSchema" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.DocumentSchema", + "client": { + "shortName": "DocumentSchemaServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaServiceClient" + }, + "method": { + "shortName": "UpdateDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.UpdateDocumentSchema", + "service": { + "shortName": "DocumentSchemaService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentSchemaService_GetDocumentSchema_async", + "title": "DocumentLinkService getDocumentSchema Sample", + "origin": "API_DEFINITION", + "description": " Gets a document schema. Returns NOT_FOUND if the document schema does not exist.", + "canonical": true, + "file": "document_schema_service.get_document_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.GetDocumentSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.DocumentSchema", + "client": { + "shortName": "DocumentSchemaServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaServiceClient" + }, + "method": { + "shortName": "GetDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.GetDocumentSchema", + "service": { + "shortName": "DocumentSchemaService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentSchemaService_DeleteDocumentSchema_async", + "title": "DocumentLinkService deleteDocumentSchema Sample", + "origin": "API_DEFINITION", + "description": " Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it.", + "canonical": true, + "file": "document_schema_service.delete_document_schema.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.DeleteDocumentSchema", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DocumentSchemaServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaServiceClient" + }, + "method": { + "shortName": "DeleteDocumentSchema", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.DeleteDocumentSchema", + "service": { + "shortName": "DocumentSchemaService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentSchemaService_ListDocumentSchemas_async", + "title": "DocumentLinkService listDocumentSchemas Sample", + "origin": "API_DEFINITION", + "description": " Lists document schemas.", + "canonical": true, + "file": "document_schema_service.list_document_schemas.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDocumentSchemas", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.ListDocumentSchemas", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.ListDocumentSchemasResponse", + "client": { + "shortName": "DocumentSchemaServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaServiceClient" + }, + "method": { + "shortName": "ListDocumentSchemas", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService.ListDocumentSchemas", + "service": { + "shortName": "DocumentSchemaService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentSchemaService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_CreateDocument_async", + "title": "DocumentLinkService createDocument Sample", + "origin": "API_DEFINITION", + "description": " Creates a document.", + "canonical": true, + "file": "document_service.create_document.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 86, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.CreateDocument", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "document", + "type": ".google.cloud.contentwarehouse.v1.Document" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "cloud_ai_document_option", + "type": ".google.cloud.contentwarehouse.v1.CloudAIDocumentOption" + }, + { + "name": "create_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.CreateDocumentResponse", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "CreateDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.CreateDocument", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_GetDocument_async", + "title": "DocumentLinkService getDocument Sample", + "origin": "API_DEFINITION", + "description": " Gets a document. Returns NOT_FOUND if the document does not exist.", + "canonical": true, + "file": "document_service.get_document.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.GetDocument", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.Document", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "GetDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.GetDocument", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_UpdateDocument_async", + "title": "DocumentLinkService updateDocument Sample", + "origin": "API_DEFINITION", + "description": " Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.", + "canonical": true, + "file": "document_service.update_document.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.UpdateDocument", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "document", + "type": ".google.cloud.contentwarehouse.v1.Document" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + }, + { + "name": "cloud_ai_document_option", + "type": ".google.cloud.contentwarehouse.v1.CloudAIDocumentOption" + }, + { + "name": "update_options", + "type": ".google.cloud.contentwarehouse.v1.UpdateOptions" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.UpdateDocumentResponse", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "UpdateDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.UpdateDocument", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_DeleteDocument_async", + "title": "DocumentLinkService deleteDocument Sample", + "origin": "API_DEFINITION", + "description": " Deletes a document. Returns NOT_FOUND if the document does not exist.", + "canonical": true, + "file": "document_service.delete_document.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.DeleteDocument", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "DeleteDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.DeleteDocument", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_SearchDocuments_async", + "title": "DocumentLinkService searchDocuments Sample", + "origin": "API_DEFINITION", + "description": " Searches for documents using provided [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest]. This call only returns documents that the caller has permission to search against.", + "canonical": true, + "file": "document_service.search_documents.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 156, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchDocuments", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.SearchDocuments", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + }, + { + "name": "document_query", + "type": ".google.cloud.contentwarehouse.v1.DocumentQuery" + }, + { + "name": "offset", + "type": "TYPE_INT32" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "histogram_queries", + "type": "TYPE_MESSAGE[]" + }, + { + "name": "require_total_size", + "type": "TYPE_BOOL" + }, + { + "name": "total_result_size", + "type": ".google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize" + }, + { + "name": "qa_size_limit", + "type": "TYPE_INT32" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.SearchDocumentsResponse", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "SearchDocuments", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.SearchDocuments", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_LockDocument_async", + "title": "DocumentLinkService lockDocument Sample", + "origin": "API_DEFINITION", + "description": " Lock the document so the document cannot be updated by other users.", + "canonical": true, + "file": "document_service.lock_document.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LockDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.LockDocument", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "collection_id", + "type": "TYPE_STRING" + }, + { + "name": "locking_user", + "type": ".google.cloud.contentwarehouse.v1.UserInfo" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.Document", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "LockDocument", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.LockDocument", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_FetchAcl_async", + "title": "DocumentLinkService fetchAcl Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.", + "canonical": true, + "file": "document_service.fetch_acl.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchAcl", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.FetchAcl", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + }, + { + "name": "project_owner", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.FetchAclResponse", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "FetchAcl", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.FetchAcl", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_DocumentService_SetAcl_async", + "title": "DocumentLinkService setAcl Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy for a resource. Replaces any existing policy.", + "canonical": true, + "file": "document_service.set_acl.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 87, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetAcl", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.SetAcl", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "request_metadata", + "type": ".google.cloud.contentwarehouse.v1.RequestMetadata" + }, + { + "name": "project_owner", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.SetAclResponse", + "client": { + "shortName": "DocumentServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.DocumentServiceClient" + }, + "method": { + "shortName": "SetAcl", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService.SetAcl", + "service": { + "shortName": "DocumentService", + "fullName": "google.cloud.contentwarehouse.v1.DocumentService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_RuleSetService_CreateRuleSet_async", + "title": "DocumentLinkService createRuleSet Sample", + "origin": "API_DEFINITION", + "description": " Creates a ruleset.", + "canonical": true, + "file": "rule_set_service.create_rule_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.CreateRuleSet", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "rule_set", + "type": ".google.cloud.contentwarehouse.v1.RuleSet" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.RuleSet", + "client": { + "shortName": "RuleSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetServiceClient" + }, + "method": { + "shortName": "CreateRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.CreateRuleSet", + "service": { + "shortName": "RuleSetService", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_RuleSetService_GetRuleSet_async", + "title": "DocumentLinkService getRuleSet Sample", + "origin": "API_DEFINITION", + "description": " Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.", + "canonical": true, + "file": "rule_set_service.get_rule_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.GetRuleSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.RuleSet", + "client": { + "shortName": "RuleSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetServiceClient" + }, + "method": { + "shortName": "GetRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.GetRuleSet", + "service": { + "shortName": "RuleSetService", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_RuleSetService_UpdateRuleSet_async", + "title": "DocumentLinkService updateRuleSet Sample", + "origin": "API_DEFINITION", + "description": " Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name.", + "canonical": true, + "file": "rule_set_service.update_rule_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.UpdateRuleSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "rule_set", + "type": ".google.cloud.contentwarehouse.v1.RuleSet" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.RuleSet", + "client": { + "shortName": "RuleSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetServiceClient" + }, + "method": { + "shortName": "UpdateRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.UpdateRuleSet", + "service": { + "shortName": "RuleSetService", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_RuleSetService_DeleteRuleSet_async", + "title": "DocumentLinkService deleteRuleSet Sample", + "origin": "API_DEFINITION", + "description": " Deletes a ruleset. Returns NOT_FOUND if the document does not exist.", + "canonical": true, + "file": "rule_set_service.delete_rule_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.DeleteRuleSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "RuleSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetServiceClient" + }, + "method": { + "shortName": "DeleteRuleSet", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.DeleteRuleSet", + "service": { + "shortName": "RuleSetService", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_RuleSetService_ListRuleSets_async", + "title": "DocumentLinkService listRuleSets Sample", + "origin": "API_DEFINITION", + "description": " Lists rulesets.", + "canonical": true, + "file": "rule_set_service.list_rule_sets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListRuleSets", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.ListRuleSets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.ListRuleSetsResponse", + "client": { + "shortName": "RuleSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetServiceClient" + }, + "method": { + "shortName": "ListRuleSets", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService.ListRuleSets", + "service": { + "shortName": "RuleSetService", + "fullName": "google.cloud.contentwarehouse.v1.RuleSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_SynonymSetService_CreateSynonymSet_async", + "title": "DocumentLinkService createSynonymSet Sample", + "origin": "API_DEFINITION", + "description": " Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.", + "canonical": true, + "file": "synonym_set_service.create_synonym_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.CreateSynonymSet", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "synonym_set", + "type": ".google.cloud.contentwarehouse.v1.SynonymSet" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.SynonymSet", + "client": { + "shortName": "SynonymSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetServiceClient" + }, + "method": { + "shortName": "CreateSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.CreateSynonymSet", + "service": { + "shortName": "SynonymSetService", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_SynonymSetService_GetSynonymSet_async", + "title": "DocumentLinkService getSynonymSet Sample", + "origin": "API_DEFINITION", + "description": " Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist", + "canonical": true, + "file": "synonym_set_service.get_synonym_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.GetSynonymSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.SynonymSet", + "client": { + "shortName": "SynonymSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetServiceClient" + }, + "method": { + "shortName": "GetSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.GetSynonymSet", + "service": { + "shortName": "SynonymSetService", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_SynonymSetService_UpdateSynonymSet_async", + "title": "DocumentLinkService updateSynonymSet Sample", + "origin": "API_DEFINITION", + "description": " Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found.", + "canonical": true, + "file": "synonym_set_service.update_synonym_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.UpdateSynonymSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "synonym_set", + "type": ".google.cloud.contentwarehouse.v1.SynonymSet" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.SynonymSet", + "client": { + "shortName": "SynonymSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetServiceClient" + }, + "method": { + "shortName": "UpdateSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.UpdateSynonymSet", + "service": { + "shortName": "SynonymSetService", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_SynonymSetService_DeleteSynonymSet_async", + "title": "DocumentLinkService deleteSynonymSet Sample", + "origin": "API_DEFINITION", + "description": " Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.", + "canonical": true, + "file": "synonym_set_service.delete_synonym_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.DeleteSynonymSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "SynonymSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetServiceClient" + }, + "method": { + "shortName": "DeleteSynonymSet", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.DeleteSynonymSet", + "service": { + "shortName": "SynonymSetService", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService" + } + } + } + }, + { + "regionTag": "contentwarehouse_v1_generated_SynonymSetService_ListSynonymSets_async", + "title": "DocumentLinkService listSynonymSets Sample", + "origin": "API_DEFINITION", + "description": " Returns all SynonymSets (for all contexts) for the specified location.", + "canonical": true, + "file": "synonym_set_service.list_synonym_sets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListSynonymSets", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.ListSynonymSets", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.contentwarehouse.v1.ListSynonymSetsResponse", + "client": { + "shortName": "SynonymSetServiceClient", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetServiceClient" + }, + "method": { + "shortName": "ListSynonymSets", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService.ListSynonymSets", + "service": { + "shortName": "SynonymSetService", + "fullName": "google.cloud.contentwarehouse.v1.SynonymSetService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-contentwarehouse/samples/package.json b/packages/google-cloud-contentwarehouse/samples/package.json index 3aa6c2b3609..ff2382ea8b8 100644 --- a/packages/google-cloud-contentwarehouse/samples/package.json +++ b/packages/google-cloud-contentwarehouse/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-contentwarehouse/src/v1/document_link_service_client.ts b/packages/google-cloud-contentwarehouse/src/v1/document_link_service_client.ts index 348fe32315d..f4e1bdf8d94 100644 --- a/packages/google-cloud-contentwarehouse/src/v1/document_link_service_client.ts +++ b/packages/google-cloud-contentwarehouse/src/v1/document_link_service_client.ts @@ -364,9 +364,8 @@ export class DocumentLinkServiceClient { * @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.contentwarehouse.v1.ListLinkedTargetsResponse | ListLinkedTargetsResponse}. - * 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.contentwarehouse.v1.ListLinkedTargetsResponse|ListLinkedTargetsResponse}. + * 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/document_link_service.list_linked_targets.js * region_tag:contentwarehouse_v1_generated_DocumentLinkService_ListLinkedTargets_async @@ -470,9 +469,8 @@ export class DocumentLinkServiceClient { * @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.contentwarehouse.v1.DocumentLink | DocumentLink}. - * 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.contentwarehouse.v1.DocumentLink|DocumentLink}. + * 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/document_link_service.create_document_link.js * region_tag:contentwarehouse_v1_generated_DocumentLinkService_CreateDocumentLink_async @@ -572,9 +570,8 @@ export class DocumentLinkServiceClient { * @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/document_link_service.delete_document_link.js * region_tag:contentwarehouse_v1_generated_DocumentLinkService_DeleteDocumentLink_async @@ -687,14 +684,13 @@ export class DocumentLinkServiceClient { * @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.contentwarehouse.v1.DocumentLink | DocumentLink}. + * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.DocumentLink|DocumentLink}. * 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 `listLinkedSourcesAsync()` * 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. */ listLinkedSources( @@ -798,13 +794,12 @@ export class DocumentLinkServiceClient { * @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.contentwarehouse.v1.DocumentLink | DocumentLink} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.DocumentLink|DocumentLink} 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 `listLinkedSourcesAsync()` * 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. */ listLinkedSourcesStream( @@ -857,12 +852,11 @@ export class DocumentLinkServiceClient { * @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.contentwarehouse.v1.DocumentLink | DocumentLink}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contentwarehouse.v1.DocumentLink|DocumentLink}. 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/document_link_service.list_linked_sources.js * region_tag:contentwarehouse_v1_generated_DocumentLinkService_ListLinkedSources_async diff --git a/packages/google-cloud-contentwarehouse/src/v1/document_schema_service_client.ts b/packages/google-cloud-contentwarehouse/src/v1/document_schema_service_client.ts index 985805c236f..340a81ff528 100644 --- a/packages/google-cloud-contentwarehouse/src/v1/document_schema_service_client.ts +++ b/packages/google-cloud-contentwarehouse/src/v1/document_schema_service_client.ts @@ -365,9 +365,8 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema}. - * 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.contentwarehouse.v1.DocumentSchema|DocumentSchema}. + * 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/document_schema_service.create_document_schema.js * region_tag:contentwarehouse_v1_generated_DocumentSchemaService_CreateDocumentSchema_async @@ -457,7 +456,7 @@ export class DocumentSchemaServiceClient { * Document Schema is non-empty and does not equal the existing name. * Supports only appending new properties, adding new ENUM possible values, * and updating the - * {@link google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled|EnumTypeOptions.validation_check_disabled} + * {@link protos.google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled|EnumTypeOptions.validation_check_disabled} * flag for ENUM possible values. Updating existing properties will result * into INVALID_ARGUMENT. * @@ -472,9 +471,8 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema}. - * 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.contentwarehouse.v1.DocumentSchema|DocumentSchema}. + * 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/document_schema_service.update_document_schema.js * region_tag:contentwarehouse_v1_generated_DocumentSchemaService_UpdateDocumentSchema_async @@ -570,9 +568,8 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema}. - * 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.contentwarehouse.v1.DocumentSchema|DocumentSchema}. + * 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/document_schema_service.get_document_schema.js * region_tag:contentwarehouse_v1_generated_DocumentSchemaService_GetDocumentSchema_async @@ -669,9 +666,8 @@ export class DocumentSchemaServiceClient { * @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/document_schema_service.delete_document_schema.js * region_tag:contentwarehouse_v1_generated_DocumentSchemaService_DeleteDocumentSchema_async @@ -779,14 +775,13 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema}. + * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.DocumentSchema|DocumentSchema}. * 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 `listDocumentSchemasAsync()` * 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. */ listDocumentSchemas( @@ -885,13 +880,12 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.DocumentSchema|DocumentSchema} 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 `listDocumentSchemasAsync()` * 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. */ listDocumentSchemasStream( @@ -939,12 +933,11 @@ export class DocumentSchemaServiceClient { * @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.contentwarehouse.v1.DocumentSchema | DocumentSchema}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contentwarehouse.v1.DocumentSchema|DocumentSchema}. 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/document_schema_service.list_document_schemas.js * region_tag:contentwarehouse_v1_generated_DocumentSchemaService_ListDocumentSchemas_async diff --git a/packages/google-cloud-contentwarehouse/src/v1/document_service_client.ts b/packages/google-cloud-contentwarehouse/src/v1/document_service_client.ts index f9745cb0aee..c421f273d02 100644 --- a/packages/google-cloud-contentwarehouse/src/v1/document_service_client.ts +++ b/packages/google-cloud-contentwarehouse/src/v1/document_service_client.ts @@ -384,9 +384,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.CreateDocumentResponse | CreateDocumentResponse}. - * 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.contentwarehouse.v1.CreateDocumentResponse|CreateDocumentResponse}. + * 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/document_service.create_document.js * region_tag:contentwarehouse_v1_generated_DocumentService_CreateDocument_async @@ -487,9 +486,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.Document | Document}. - * 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.contentwarehouse.v1.Document|Document}. + * 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/document_service.get_document.js * region_tag:contentwarehouse_v1_generated_DocumentService_GetDocument_async @@ -595,9 +593,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.UpdateDocumentResponse | UpdateDocumentResponse}. - * 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.contentwarehouse.v1.UpdateDocumentResponse|UpdateDocumentResponse}. + * 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/document_service.update_document.js * region_tag:contentwarehouse_v1_generated_DocumentService_UpdateDocument_async @@ -699,9 +696,8 @@ export class DocumentServiceClient { * @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/document_service.delete_document.js * region_tag:contentwarehouse_v1_generated_DocumentService_DeleteDocument_async @@ -802,9 +798,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.Document | Document}. - * 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.contentwarehouse.v1.Document|Document}. + * 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/document_service.lock_document.js * region_tag:contentwarehouse_v1_generated_DocumentService_LockDocument_async @@ -906,9 +901,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.FetchAclResponse | FetchAclResponse}. - * 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.contentwarehouse.v1.FetchAclResponse|FetchAclResponse}. + * 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/document_service.fetch_acl.js * region_tag:contentwarehouse_v1_generated_DocumentService_FetchAcl_async @@ -1029,9 +1023,8 @@ export class DocumentServiceClient { * @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.contentwarehouse.v1.SetAclResponse | SetAclResponse}. - * 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.contentwarehouse.v1.SetAclResponse|SetAclResponse}. + * 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/document_service.set_acl.js * region_tag:contentwarehouse_v1_generated_DocumentService_SetAcl_async @@ -1107,7 +1100,7 @@ export class DocumentServiceClient { /** * Searches for documents using provided - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsRequest|SearchDocumentsRequest}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsRequest|SearchDocumentsRequest}. * This call only returns documents that the caller has permission to search * against. * @@ -1125,7 +1118,7 @@ export class DocumentServiceClient { * An integer that specifies the current offset (that is, starting result * location, amongst the documents deemed by the API as relevant) in search * results. This field is only considered if - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} * is unset. * * The maximum allowed value is 5000. Otherwise an error is thrown. @@ -1141,7 +1134,7 @@ export class DocumentServiceClient { * @param {string} request.pageToken * The token specifying the current offset within search results. * See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} * for an explanation of how to obtain the next set of query results. * @param {string} request.orderBy * The criteria determining how search results are sorted. For non-empty @@ -1173,7 +1166,7 @@ export class DocumentServiceClient { * * * Histogram facet (aka filterable properties): Facet names with format * <schema id>.<facet>. Facets will have the - * format of: `{@link a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child + * format of: `{@link protos.a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child * facet, then the parent hierarchy needs to be specified separated by * dots in the prefix after the schema id. Thus, the format for a multi- * level facet is: <schema id>.<parent facet name>. @@ -1193,7 +1186,7 @@ export class DocumentServiceClient { * @param {boolean} request.requireTotalSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * * Enabling this flag may adversely impact performance. Hint: If this is * used with pagination, set this flag on the initial query but set this @@ -1203,23 +1196,22 @@ export class DocumentServiceClient { * @param {google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize} request.totalResultSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * @param {number} request.qaSizeLimit * Experimental, do not use. * The limit on the number of documents returned for the question-answering * feature. To enable the question-answering feature, set - * {@link |DocumentQuery].[is_nl_query} to true. + * {@link protos.|DocumentQuery].[is_nl_query} to true. * @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.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument | MatchingDocument}. + * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument|MatchingDocument}. * 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 `searchDocumentsAsync()` * 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. */ searchDocuments( @@ -1313,7 +1305,7 @@ export class DocumentServiceClient { * An integer that specifies the current offset (that is, starting result * location, amongst the documents deemed by the API as relevant) in search * results. This field is only considered if - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} * is unset. * * The maximum allowed value is 5000. Otherwise an error is thrown. @@ -1329,7 +1321,7 @@ export class DocumentServiceClient { * @param {string} request.pageToken * The token specifying the current offset within search results. * See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} * for an explanation of how to obtain the next set of query results. * @param {string} request.orderBy * The criteria determining how search results are sorted. For non-empty @@ -1361,7 +1353,7 @@ export class DocumentServiceClient { * * * Histogram facet (aka filterable properties): Facet names with format * <schema id>.<facet>. Facets will have the - * format of: `{@link a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child + * format of: `{@link protos.a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child * facet, then the parent hierarchy needs to be specified separated by * dots in the prefix after the schema id. Thus, the format for a multi- * level facet is: <schema id>.<parent facet name>. @@ -1381,7 +1373,7 @@ export class DocumentServiceClient { * @param {boolean} request.requireTotalSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * * Enabling this flag may adversely impact performance. Hint: If this is * used with pagination, set this flag on the initial query but set this @@ -1391,22 +1383,21 @@ export class DocumentServiceClient { * @param {google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize} request.totalResultSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * @param {number} request.qaSizeLimit * Experimental, do not use. * The limit on the number of documents returned for the question-answering * feature. To enable the question-answering feature, set - * {@link |DocumentQuery].[is_nl_query} to true. + * {@link protos.|DocumentQuery].[is_nl_query} to true. * @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.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument | MatchingDocument} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument|MatchingDocument} 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 `searchDocumentsAsync()` * 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. */ searchDocumentsStream( @@ -1449,7 +1440,7 @@ export class DocumentServiceClient { * An integer that specifies the current offset (that is, starting result * location, amongst the documents deemed by the API as relevant) in search * results. This field is only considered if - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token|page_token} * is unset. * * The maximum allowed value is 5000. Otherwise an error is thrown. @@ -1465,7 +1456,7 @@ export class DocumentServiceClient { * @param {string} request.pageToken * The token specifying the current offset within search results. * See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token|SearchDocumentsResponse.next_page_token} * for an explanation of how to obtain the next set of query results. * @param {string} request.orderBy * The criteria determining how search results are sorted. For non-empty @@ -1497,7 +1488,7 @@ export class DocumentServiceClient { * * * Histogram facet (aka filterable properties): Facet names with format * <schema id>.<facet>. Facets will have the - * format of: `{@link a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child + * format of: `{@link protos.a-zA-Z0-9_:/-.|a-zA-Z}`. If the facet is a child * facet, then the parent hierarchy needs to be specified separated by * dots in the prefix after the schema id. Thus, the format for a multi- * level facet is: <schema id>.<parent facet name>. @@ -1517,7 +1508,7 @@ export class DocumentServiceClient { * @param {boolean} request.requireTotalSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * * Enabling this flag may adversely impact performance. Hint: If this is * used with pagination, set this flag on the initial query but set this @@ -1527,21 +1518,20 @@ export class DocumentServiceClient { * @param {google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize} request.totalResultSize * Controls if the search document request requires the return of a total size * of matched documents. See - * {@link google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size|SearchDocumentsResponse.total_size}. * @param {number} request.qaSizeLimit * Experimental, do not use. * The limit on the number of documents returned for the question-answering * feature. To enable the question-answering feature, set - * {@link |DocumentQuery].[is_nl_query} to true. + * {@link protos.|DocumentQuery].[is_nl_query} to true. * @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.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument | MatchingDocument}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument|MatchingDocument}. 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/document_service.search_documents.js * region_tag:contentwarehouse_v1_generated_DocumentService_SearchDocuments_async diff --git a/packages/google-cloud-contentwarehouse/src/v1/rule_set_service_client.ts b/packages/google-cloud-contentwarehouse/src/v1/rule_set_service_client.ts index 7dc39464fb8..64223e001cb 100644 --- a/packages/google-cloud-contentwarehouse/src/v1/rule_set_service_client.ts +++ b/packages/google-cloud-contentwarehouse/src/v1/rule_set_service_client.ts @@ -361,9 +361,8 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet}. - * 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.contentwarehouse.v1.RuleSet|RuleSet}. + * 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/rule_set_service.create_rule_set.js * region_tag:contentwarehouse_v1_generated_RuleSetService_CreateRuleSet_async @@ -454,9 +453,8 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet}. - * 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.contentwarehouse.v1.RuleSet|RuleSet}. + * 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/rule_set_service.get_rule_set.js * region_tag:contentwarehouse_v1_generated_RuleSetService_GetRuleSet_async @@ -550,9 +548,8 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet}. - * 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.contentwarehouse.v1.RuleSet|RuleSet}. + * 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/rule_set_service.update_rule_set.js * region_tag:contentwarehouse_v1_generated_RuleSetService_UpdateRuleSet_async @@ -643,9 +640,8 @@ export class RuleSetServiceClient { * @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/rule_set_service.delete_rule_set.js * region_tag:contentwarehouse_v1_generated_RuleSetService_DeleteRuleSet_async @@ -747,14 +743,13 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet}. + * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.RuleSet|RuleSet}. * 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 `listRuleSetsAsync()` * 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. */ listRuleSets( @@ -853,13 +848,12 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.RuleSet|RuleSet} 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 `listRuleSetsAsync()` * 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. */ listRuleSetsStream( @@ -907,12 +901,11 @@ export class RuleSetServiceClient { * @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.contentwarehouse.v1.RuleSet | RuleSet}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contentwarehouse.v1.RuleSet|RuleSet}. 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/rule_set_service.list_rule_sets.js * region_tag:contentwarehouse_v1_generated_RuleSetService_ListRuleSets_async diff --git a/packages/google-cloud-contentwarehouse/src/v1/synonym_set_service_client.ts b/packages/google-cloud-contentwarehouse/src/v1/synonym_set_service_client.ts index 6d80f2eb5eb..1f131b76178 100644 --- a/packages/google-cloud-contentwarehouse/src/v1/synonym_set_service_client.ts +++ b/packages/google-cloud-contentwarehouse/src/v1/synonym_set_service_client.ts @@ -364,9 +364,8 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet}. - * 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.contentwarehouse.v1.SynonymSet|SynonymSet}. + * 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/synonym_set_service.create_synonym_set.js * region_tag:contentwarehouse_v1_generated_SynonymSetService_CreateSynonymSet_async @@ -465,9 +464,8 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet}. - * 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.contentwarehouse.v1.SynonymSet|SynonymSet}. + * 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/synonym_set_service.get_synonym_set.js * region_tag:contentwarehouse_v1_generated_SynonymSetService_GetSynonymSet_async @@ -562,9 +560,8 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet}. - * 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.contentwarehouse.v1.SynonymSet|SynonymSet}. + * 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/synonym_set_service.update_synonym_set.js * region_tag:contentwarehouse_v1_generated_SynonymSetService_UpdateSynonymSet_async @@ -662,9 +659,8 @@ export class SynonymSetServiceClient { * @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/synonym_set_service.delete_synonym_set.js * region_tag:contentwarehouse_v1_generated_SynonymSetService_DeleteSynonymSet_async @@ -772,14 +768,13 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet}. + * The first element of the array is Array of {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet}. * 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 `listSynonymSetsAsync()` * 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. */ listSynonymSets( @@ -878,13 +873,12 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet} 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 `listSynonymSetsAsync()` * 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. */ listSynonymSetsStream( @@ -932,12 +926,11 @@ export class SynonymSetServiceClient { * @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.contentwarehouse.v1.SynonymSet | SynonymSet}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.contentwarehouse.v1.SynonymSet|SynonymSet}. 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/synonym_set_service.list_synonym_sets.js * region_tag:contentwarehouse_v1_generated_SynonymSetService_ListSynonymSets_async diff --git a/packages/google-cloud-datacatalog-lineage/README.md b/packages/google-cloud-datacatalog-lineage/README.md index bdaa5e2cf3a..4bba583af77 100644 --- a/packages/google-cloud-datacatalog-lineage/README.md +++ b/packages/google-cloud-datacatalog-lineage/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Data Lineage API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Data Lineage API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-datacatalog-lineage) [![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/lineage.svg)](https://www.npmjs.org/package/@google-cloud/lineage) @@ -110,28 +110,27 @@ callListProcesses(); ## 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-datacatalog-lineage/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Lineage.batch_search_link_processes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js,samples/README.md) | -| Lineage.create_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_lineage_event.js,samples/README.md) | -| Lineage.create_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_process.js,samples/README.md) | -| Lineage.create_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_run.js,samples/README.md) | -| Lineage.delete_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_lineage_event.js,samples/README.md) | -| Lineage.delete_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_process.js,samples/README.md) | -| Lineage.delete_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_run.js,samples/README.md) | -| Lineage.get_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_lineage_event.js,samples/README.md) | -| Lineage.get_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_process.js,samples/README.md) | -| Lineage.get_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_run.js,samples/README.md) | -| Lineage.list_lineage_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_lineage_events.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_lineage_events.js,samples/README.md) | -| Lineage.list_processes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_processes.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_processes.js,samples/README.md) | -| Lineage.list_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_runs.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_runs.js,samples/README.md) | -| Lineage.search_links | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.search_links.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.search_links.js,samples/README.md) | -| Lineage.update_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.update_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.update_process.js,samples/README.md) | -| Lineage.update_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.update_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.update_run.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/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-datacatalog-lineage/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/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-datacatalog-lineage/samples/test/quickstart.js,samples/README.md) | +| Lineage.batch_search_link_processes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.create_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_lineage_event.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.create_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_process.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.create_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.create_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.create_run.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.delete_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_lineage_event.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.delete_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_process.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.delete_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.delete_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.delete_run.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.get_lineage_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_lineage_event.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_lineage_event.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.get_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_process.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.get_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.get_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.get_run.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.list_lineage_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_lineage_events.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_lineage_events.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.list_processes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_processes.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_processes.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.list_runs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.list_runs.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.list_runs.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.search_links | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.search_links.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.search_links.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.update_process | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.update_process.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.update_process.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Lineage.update_run | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.update_run.js) | [![Open in Cloud Shell][shell_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-datacatalog-lineage/samples/generated/v1/lineage.update_run.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/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-datacatalog-lineage/samples/quickstart.js,packages/google-cloud-datacatalog-lineage/samples/README.md) | diff --git a/packages/google-cloud-datacatalog-lineage/package.json b/packages/google-cloud-datacatalog-lineage/package.json index ac6d78d47ac..1922c00994f 100644 --- a/packages/google-cloud-datacatalog-lineage/package.json +++ b/packages/google-cloud-datacatalog-lineage/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": "^4.2.0" }, "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" } } diff --git a/packages/google-cloud-datacatalog-lineage/samples/README.md b/packages/google-cloud-datacatalog-lineage/samples/README.md index ee4e4fb3190..4e704d7151a 100644 --- a/packages/google-cloud-datacatalog-lineage/samples/README.md +++ b/packages/google-cloud-datacatalog-lineage/samples/README.md @@ -29,7 +29,6 @@ * [Lineage.update_process](#lineage.update_process) * [Lineage.update_run](#lineage.update_run) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -330,23 +329,6 @@ __Usage:__ `node packages/google-cloud-datacatalog-lineage/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datacatalog-lineage/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-datacatalog-lineage/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-datacatalog-lineage/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js index ae3d1da64fe..d09ee6bf81d 100644 --- a/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js +++ b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/lineage.batch_search_link_processes.js @@ -39,7 +39,7 @@ function main(parent, links) { * `INVALID_ARGUMENT` error. * Format: `projects/{project}/locations/{location}/links/{link}`. */ - // const links = 'abc123' + // const links = ['abc','def'] /** * The maximum number of processes to return in a single page of the response. * A page may contain fewer results than this value. diff --git a/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata.google.cloud.datacatalog.lineage.v1.json b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata.google.cloud.datacatalog.lineage.v1.json index 19c86ed4292..40056d4e0dd 100644 --- a/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata.google.cloud.datacatalog.lineage.v1.json +++ b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata.google.cloud.datacatalog.lineage.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-lineage", - "version": "0.1.1", + "version": "0.1.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.lineage.v1.json b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.lineage.v1.json new file mode 100644 index 00000000000..40056d4e0dd --- /dev/null +++ b/packages/google-cloud-datacatalog-lineage/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.lineage.v1.json @@ -0,0 +1,755 @@ +{ + "clientLibrary": { + "name": "nodejs-lineage", + "version": "0.1.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datacatalog.lineage.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "datalineage_v1_generated_Lineage_CreateProcess_async", + "title": "Lineage createProcess Sample", + "origin": "API_DEFINITION", + "description": " Creates a new process.", + "canonical": true, + "file": "lineage.create_process.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "process", + "type": ".google.cloud.datacatalog.lineage.v1.Process" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Process", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "CreateProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateProcess", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_UpdateProcess_async", + "title": "Lineage updateProcess Sample", + "origin": "API_DEFINITION", + "description": " Updates a process.", + "canonical": true, + "file": "lineage.update_process.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess", + "async": true, + "parameters": [ + { + "name": "process", + "type": ".google.cloud.datacatalog.lineage.v1.Process" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Process", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "UpdateProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateProcess", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_GetProcess_async", + "title": "Lineage getProcess Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of the specified process.", + "canonical": true, + "file": "lineage.get_process.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetProcess", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Process", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "GetProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetProcess", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_ListProcesses_async", + "title": "Lineage listProcesses Sample", + "origin": "API_DEFINITION", + "description": " List processes in the given project and location. List order is descending by insertion time.", + "canonical": true, + "file": "lineage.list_processes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListProcesses", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.ListProcessesResponse", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "ListProcesses", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListProcesses", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_DeleteProcess_async", + "title": "Lineage deleteProcess Sample", + "origin": "API_DEFINITION", + "description": " Deletes the process with the specified name.", + "canonical": true, + "file": "lineage.delete_process.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "DeleteProcess", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteProcess", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_CreateRun_async", + "title": "Lineage createRun Sample", + "origin": "API_DEFINITION", + "description": " Creates a new run.", + "canonical": true, + "file": "lineage.create_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateRun", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "run", + "type": ".google.cloud.datacatalog.lineage.v1.Run" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Run", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "CreateRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateRun", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_UpdateRun_async", + "title": "Lineage updateRun Sample", + "origin": "API_DEFINITION", + "description": " Updates a run.", + "canonical": true, + "file": "lineage.update_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun", + "async": true, + "parameters": [ + { + "name": "run", + "type": ".google.cloud.datacatalog.lineage.v1.Run" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Run", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "UpdateRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.UpdateRun", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_GetRun_async", + "title": "Lineage getRun Sample", + "origin": "API_DEFINITION", + "description": " Gets the details of the specified run.", + "canonical": true, + "file": "lineage.get_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.Run", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "GetRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetRun", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_ListRuns_async", + "title": "Lineage listRuns Sample", + "origin": "API_DEFINITION", + "description": " Lists runs in the given project and location. List order is descending by `start_time`.", + "canonical": true, + "file": "lineage.list_runs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListRuns", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListRuns", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.ListRunsResponse", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "ListRuns", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListRuns", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_DeleteRun_async", + "title": "Lineage deleteRun Sample", + "origin": "API_DEFINITION", + "description": " Deletes the run with the specified name.", + "canonical": true, + "file": "lineage.delete_run.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "DeleteRun", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteRun", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_CreateLineageEvent_async", + "title": "Lineage createLineageEvent Sample", + "origin": "API_DEFINITION", + "description": " Creates a new lineage event.", + "canonical": true, + "file": "lineage.create_lineage_event.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "lineage_event", + "type": ".google.cloud.datacatalog.lineage.v1.LineageEvent" + }, + { + "name": "request_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.LineageEvent", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "CreateLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.CreateLineageEvent", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_GetLineageEvent_async", + "title": "Lineage getLineageEvent Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a specified lineage event.", + "canonical": true, + "file": "lineage.get_lineage_event.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.LineageEvent", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "GetLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.GetLineageEvent", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_ListLineageEvents_async", + "title": "Lineage listLineageEvents Sample", + "origin": "API_DEFINITION", + "description": " Lists lineage events in the given project and location. The list order is not defined.", + "canonical": true, + "file": "lineage.list_lineage_events.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListLineageEvents", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.ListLineageEventsResponse", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "ListLineageEvents", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.ListLineageEvents", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_DeleteLineageEvent_async", + "title": "Lineage deleteLineageEvent Sample", + "origin": "API_DEFINITION", + "description": " Deletes the lineage event with the specified name.", + "canonical": true, + "file": "lineage.delete_lineage_event.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "allow_missing", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "DeleteLineageEvent", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.DeleteLineageEvent", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_SearchLinks_async", + "title": "Lineage searchLinks Sample", + "origin": "API_DEFINITION", + "description": " Retrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them. You can retrieve links in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.", + "canonical": true, + "file": "lineage.search_links.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchLinks", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "source", + "type": ".google.cloud.datacatalog.lineage.v1.EntityReference" + }, + { + "name": "target", + "type": ".google.cloud.datacatalog.lineage.v1.EntityReference" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.SearchLinksResponse", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "SearchLinks", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + }, + { + "regionTag": "datalineage_v1_generated_Lineage_BatchSearchLinkProcesses_async", + "title": "Lineage batchSearchLinkProcesses Sample", + "origin": "API_DEFINITION", + "description": " Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from **source** to **target** assets. Links between assets represent this operation. If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks] method for more information on how to retrieve link name. You can retrieve the LineageProcess information in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.", + "canonical": true, + "file": "lineage.batch_search_link_processes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "BatchSearchLinkProcesses", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "links", + "type": "TYPE_STRING[]" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesResponse", + "client": { + "shortName": "LineageClient", + "fullName": "google.cloud.datacatalog.lineage.v1.LineageClient" + }, + "method": { + "shortName": "BatchSearchLinkProcesses", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses", + "service": { + "shortName": "Lineage", + "fullName": "google.cloud.datacatalog.lineage.v1.Lineage" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datacatalog-lineage/samples/package.json b/packages/google-cloud-datacatalog-lineage/samples/package.json index 77f4aed10f2..00ad0674e21 100644 --- a/packages/google-cloud-datacatalog-lineage/samples/package.json +++ b/packages/google-cloud-datacatalog-lineage/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-datacatalog-lineage/src/v1/lineage_client.ts b/packages/google-cloud-datacatalog-lineage/src/v1/lineage_client.ts index bfda7c88d19..e76fb625094 100644 --- a/packages/google-cloud-datacatalog-lineage/src/v1/lineage_client.ts +++ b/packages/google-cloud-datacatalog-lineage/src/v1/lineage_client.ts @@ -41,7 +41,7 @@ const version = require('../../../package.json').version; /** * Lineage is used to track data flows between assets over time. You can - * create {@link google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvents} + * create {@link protos.google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvents} * to record lineage between multiple sources and a single target, for * example, when table data is based on data from multiple tables. * @class @@ -460,9 +460,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process}. - * 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.datacatalog.lineage.v1.Process|Process}. + * 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/lineage.create_process.js * region_tag:datalineage_v1_generated_Lineage_CreateProcess_async @@ -564,9 +563,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process}. - * 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.datacatalog.lineage.v1.Process|Process}. + * 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/lineage.update_process.js * region_tag:datalineage_v1_generated_Lineage_UpdateProcess_async @@ -661,9 +659,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process}. - * 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.datacatalog.lineage.v1.Process|Process}. + * 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/lineage.get_process.js * region_tag:datalineage_v1_generated_Lineage_GetProcess_async @@ -758,9 +755,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run}. - * 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.datacatalog.lineage.v1.Run|Run}. + * 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/lineage.create_run.js * region_tag:datalineage_v1_generated_Lineage_CreateRun_async @@ -857,9 +853,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run}. - * 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.datacatalog.lineage.v1.Run|Run}. + * 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/lineage.update_run.js * region_tag:datalineage_v1_generated_Lineage_UpdateRun_async @@ -948,9 +943,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run}. - * 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.datacatalog.lineage.v1.Run|Run}. + * 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/lineage.get_run.js * region_tag:datalineage_v1_generated_Lineage_GetRun_async @@ -1045,9 +1039,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.LineageEvent | LineageEvent}. - * 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.datacatalog.lineage.v1.LineageEvent|LineageEvent}. + * 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/lineage.create_lineage_event.js * region_tag:datalineage_v1_generated_Lineage_CreateLineageEvent_async @@ -1142,9 +1135,8 @@ export class LineageClient { * @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.datacatalog.lineage.v1.LineageEvent | LineageEvent}. - * 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.datacatalog.lineage.v1.LineageEvent|LineageEvent}. + * 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/lineage.get_lineage_event.js * region_tag:datalineage_v1_generated_Lineage_GetLineageEvent_async @@ -1242,9 +1234,8 @@ export class LineageClient { * @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/lineage.delete_lineage_event.js * region_tag:datalineage_v1_generated_Lineage_DeleteLineageEvent_async @@ -1346,8 +1337,7 @@ export class LineageClient { * 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/lineage.delete_process.js * region_tag:datalineage_v1_generated_Lineage_DeleteProcess_async @@ -1442,8 +1432,7 @@ export class LineageClient { * 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/lineage.delete_process.js * region_tag:datalineage_v1_generated_Lineage_DeleteProcess_async @@ -1487,8 +1476,7 @@ export class LineageClient { * 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/lineage.delete_run.js * region_tag:datalineage_v1_generated_Lineage_DeleteRun_async @@ -1583,8 +1571,7 @@ export class LineageClient { * 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/lineage.delete_run.js * region_tag:datalineage_v1_generated_Lineage_DeleteRun_async @@ -1635,14 +1622,13 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.lineage.v1.Process|Process}. * 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 `listProcessesAsync()` * 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. */ listProcesses( @@ -1741,13 +1727,12 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.lineage.v1.Process|Process} 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 `listProcessesAsync()` * 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. */ listProcessesStream( @@ -1795,12 +1780,11 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Process | Process}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.lineage.v1.Process|Process}. 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/lineage.list_processes.js * region_tag:datalineage_v1_generated_Lineage_ListProcesses_async @@ -1848,14 +1832,13 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.lineage.v1.Run|Run}. * 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 `listRunsAsync()` * 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. */ listRuns( @@ -1953,13 +1936,12 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.lineage.v1.Run|Run} 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 `listRunsAsync()` * 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. */ listRunsStream( @@ -2006,12 +1988,11 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Run | Run}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.lineage.v1.Run|Run}. 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/lineage.list_runs.js * region_tag:datalineage_v1_generated_Lineage_ListRuns_async @@ -2061,14 +2042,13 @@ export class LineageClient { * @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.datacatalog.lineage.v1.LineageEvent | LineageEvent}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvent}. * 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 `listLineageEventsAsync()` * 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. */ listLineageEvents( @@ -2168,13 +2148,12 @@ export class LineageClient { * @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.datacatalog.lineage.v1.LineageEvent | LineageEvent} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvent} 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 `listLineageEventsAsync()` * 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. */ listLineageEventsStream( @@ -2223,12 +2202,11 @@ export class LineageClient { * @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.datacatalog.lineage.v1.LineageEvent | LineageEvent}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.lineage.v1.LineageEvent|LineageEvent}. 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/lineage.list_lineage_events.js * region_tag:datalineage_v1_generated_Lineage_ListLineageEvents_async @@ -2291,14 +2269,13 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Link | Link}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.lineage.v1.Link|Link}. * 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 `searchLinksAsync()` * 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. */ searchLinks( @@ -2404,13 +2381,12 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Link | Link} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.lineage.v1.Link|Link} 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 `searchLinksAsync()` * 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. */ searchLinksStream( @@ -2465,12 +2441,11 @@ export class LineageClient { * @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.datacatalog.lineage.v1.Link | Link}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.lineage.v1.Link|Link}. 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/lineage.search_links.js * region_tag:datalineage_v1_generated_Lineage_SearchLinks_async @@ -2505,7 +2480,7 @@ export class LineageClient { * If you have specific link names, you can use this method to * verify which LineageProcesses contribute to creating those links. * See the - * {@link google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks|SearchLinks} + * {@link protos.google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks|SearchLinks} * method for more information on how to retrieve link name. * * You can retrieve the LineageProcess information in every project where you @@ -2537,14 +2512,13 @@ export class LineageClient { * @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.datacatalog.lineage.v1.ProcessLinks | ProcessLinks}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.lineage.v1.ProcessLinks|ProcessLinks}. * 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 `batchSearchLinkProcessesAsync()` * 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. */ batchSearchLinkProcesses( @@ -2653,13 +2627,12 @@ export class LineageClient { * @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.datacatalog.lineage.v1.ProcessLinks | ProcessLinks} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.lineage.v1.ProcessLinks|ProcessLinks} 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 `batchSearchLinkProcessesAsync()` * 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. */ batchSearchLinkProcessesStream( @@ -2713,12 +2686,11 @@ export class LineageClient { * @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.datacatalog.lineage.v1.ProcessLinks | ProcessLinks}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.lineage.v1.ProcessLinks|ProcessLinks}. 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/lineage.batch_search_link_processes.js * region_tag:datalineage_v1_generated_Lineage_BatchSearchLinkProcesses_async diff --git a/packages/google-cloud-datacatalog/package.json b/packages/google-cloud-datacatalog/package.json index 4ffa6e3ecdc..0da57e3d9a3 100644 --- a/packages/google-cloud-datacatalog/package.json +++ b/packages/google-cloud-datacatalog/package.json @@ -30,15 +30,16 @@ "Google Cloud Data Catalog API" ], "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.0.0", "chai": "^4.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", @@ -47,7 +48,7 @@ "mocha": "^9.2.2", "pack-n-play": "^1.0.0-2", "sinon": "^15.0.0", - "typescript": "^4.6.4" + "typescript": "^5.1.6" }, "scripts": { "clean": "gts clean", @@ -67,7 +68,7 @@ }, "license": "Apache-2.0", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-datacatalog" } diff --git a/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.reconcile_tags.js b/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.reconcile_tags.js index 46d6cff7e6d..e99bb6eb9ae 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.reconcile_tags.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.reconcile_tags.js @@ -48,7 +48,7 @@ function main(parent, tagTemplate) { * `ReconcileTagsRequest`. * The sole entry and each of its columns must be mentioned at most once. */ - // const tags = 1234 + // const tags = [1,2,3,4] // Imports the Datacatalog library const {DataCatalogClient} = require('@google-cloud/datacatalog').v1; diff --git a/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.test_iam_permissions.js b/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.test_iam_permissions.js index 734e9535cd9..8f1833c2934 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.test_iam_permissions.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1/data_catalog.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datacatalog library const {DataCatalogClient} = require('@google-cloud/datacatalog').v1; diff --git a/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager.test_iam_permissions.js b/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager.test_iam_permissions.js index de3c3bf1bea..cb61d27f75f 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager.test_iam_permissions.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datacatalog library const {PolicyTagManagerClient} = require('@google-cloud/datacatalog').v1; diff --git a/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager_serialization.export_taxonomies.js b/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager_serialization.export_taxonomies.js index 250d83d699f..c311f946ab2 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager_serialization.export_taxonomies.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1/policy_tag_manager_serialization.export_taxonomies.js @@ -36,7 +36,7 @@ function main(parent, taxonomies) { /** * Required. Resource names of the taxonomies to export. */ - // const taxonomies = 'abc123' + // const taxonomies = ['abc','def'] /** * Serialized export taxonomies that contain all the policy * tags as nested protocol buffers. diff --git a/packages/google-cloud-datacatalog/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.v1.json b/packages/google-cloud-datacatalog/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.v1.json new file mode 100644 index 00000000000..f86446de339 --- /dev/null +++ b/packages/google-cloud-datacatalog/samples/generated/v1/snippet_metadata_google.cloud.datacatalog.v1.json @@ -0,0 +1,2275 @@ +{ + "clientLibrary": { + "name": "nodejs-datacatalog", + "version": "3.5.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datacatalog.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "datacatalog_v1_generated_DataCatalog_SearchCatalog_async", + "title": "DataCatalog searchCatalog Sample", + "origin": "API_DEFINITION", + "description": " Searches Data Catalog for multiple resources like entries and tags that match a query. This is a [Custom Method] (https://cloud.google.com/apis/design/custom_methods) that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods. Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. For more information, see [Data Catalog search syntax] (https://cloud.google.com/data-catalog/docs/how-to/search-reference).", + "canonical": true, + "file": "data_catalog.search_catalog.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 102, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.SearchCatalog", + "async": true, + "parameters": [ + { + "name": "scope", + "type": ".google.cloud.datacatalog.v1.SearchCatalogRequest.Scope" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.SearchCatalogResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "SearchCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.SearchCatalog", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_CreateEntryGroup_async", + "title": "DataCatalog createEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Creates an entry group. An entry group contains logically related entries together with [Cloud Identity and Access Management](/data-catalog/docs/concepts/iam) policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the `@` symbol for the following resources: * BigQuery entries (`@bigquery`) * Pub/Sub topics (`@pubsub`) * Dataproc Metastore services (`@dataproc_metastore_{SERVICE_NAME_HASH}`) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the `@` symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.create_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entry_group_id", + "type": "TYPE_STRING" + }, + { + "name": "entry_group", + "type": ".google.cloud.datacatalog.v1.EntryGroup" + } + ], + "resultType": ".google.cloud.datacatalog.v1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "CreateEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_GetEntryGroup_async", + "title": "DataCatalog getEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Gets an entry group.", + "canonical": true, + "file": "data_catalog.get_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "GetEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UpdateEntryGroup_async", + "title": "DataCatalog updateEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Updates an entry group. You must enable the Data Catalog API in the project identified by the `entry_group.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.update_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup", + "async": true, + "parameters": [ + { + "name": "entry_group", + "type": ".google.cloud.datacatalog.v1.EntryGroup" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_DeleteEntryGroup_async", + "title": "DataCatalog deleteEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Deletes an entry group. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.delete_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteEntryGroup", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ListEntryGroups_async", + "title": "DataCatalog listEntryGroups Sample", + "origin": "API_DEFINITION", + "description": " Lists entry groups.", + "canonical": true, + "file": "data_catalog.list_entry_groups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntryGroups", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ListEntryGroupsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ListEntryGroups", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_CreateEntry_async", + "title": "DataCatalog createEntry Sample", + "origin": "API_DEFINITION", + "description": " Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries.", + "canonical": true, + "file": "data_catalog.create_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 68, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntry", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entry_id", + "type": "TYPE_STRING" + }, + { + "name": "entry", + "type": ".google.cloud.datacatalog.v1.Entry" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "CreateEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UpdateEntry_async", + "title": "DataCatalog updateEntry Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.update_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntry", + "async": true, + "parameters": [ + { + "name": "entry", + "type": ".google.cloud.datacatalog.v1.Entry" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_DeleteEntry_async", + "title": "DataCatalog deleteEntry Sample", + "origin": "API_DEFINITION", + "description": " Deletes an existing entry. You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.delete_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_GetEntry_async", + "title": "DataCatalog getEntry Sample", + "origin": "API_DEFINITION", + "description": " Gets an entry.", + "canonical": true, + "file": "data_catalog.get_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "GetEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_LookupEntry_async", + "title": "DataCatalog lookupEntry Sample", + "origin": "API_DEFINITION", + "description": " Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service.", + "canonical": true, + "file": "data_catalog.lookup_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.LookupEntry", + "async": true, + "parameters": [ + { + "name": "linked_resource", + "type": "TYPE_STRING" + }, + { + "name": "sql_resource", + "type": "TYPE_STRING" + }, + { + "name": "fully_qualified_name", + "type": "TYPE_STRING" + }, + { + "name": "project", + "type": "TYPE_STRING" + }, + { + "name": "location", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "LookupEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.LookupEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ListEntries_async", + "title": "DataCatalog listEntries Sample", + "origin": "API_DEFINITION", + "description": " Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].", + "canonical": true, + "file": "data_catalog.list_entries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntries", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ListEntriesResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ListEntries", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListEntries", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ModifyEntryOverview_async", + "title": "DataCatalog modifyEntryOverview Sample", + "origin": "API_DEFINITION", + "description": " Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project.", + "canonical": true, + "file": "data_catalog.modify_entry_overview.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ModifyEntryOverview", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "entry_overview", + "type": ".google.cloud.datacatalog.v1.EntryOverview" + } + ], + "resultType": ".google.cloud.datacatalog.v1.EntryOverview", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ModifyEntryOverview", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ModifyEntryContacts_async", + "title": "DataCatalog modifyEntryContacts Sample", + "origin": "API_DEFINITION", + "description": " Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry]. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project.", + "canonical": true, + "file": "data_catalog.modify_entry_contacts.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ModifyEntryContacts", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "contacts", + "type": ".google.cloud.datacatalog.v1.Contacts" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Contacts", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ModifyEntryContacts", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_CreateTagTemplate_async", + "title": "DataCatalog createTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.create_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_id", + "type": "TYPE_STRING" + }, + { + "name": "tag_template", + "type": ".google.cloud.datacatalog.v1.TagTemplate" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_GetTagTemplate_async", + "title": "DataCatalog getTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Gets a tag template.", + "canonical": true, + "file": "data_catalog.get_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "GetTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTagTemplate_async", + "title": "DataCatalog updateTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.update_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate", + "async": true, + "parameters": [ + { + "name": "tag_template", + "type": ".google.cloud.datacatalog.v1.TagTemplate" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTagTemplate_async", + "title": "DataCatalog deleteTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.delete_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTagTemplate", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_CreateTagTemplateField_async", + "title": "DataCatalog createTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Creates a field in a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.create_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field_id", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field", + "type": ".google.cloud.datacatalog.v1.TagTemplateField" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTagTemplateField_async", + "title": "DataCatalog updateTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Updates a field in a tag template. You can't update the field type with this method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.update_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field", + "type": ".google.cloud.datacatalog.v1.TagTemplateField" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_RenameTagTemplateField_async", + "title": "DataCatalog renameTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Renames a field in a tag template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.rename_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RenameTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "new_tag_template_field_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "RenameTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_RenameTagTemplateFieldEnumValue_async", + "title": "DataCatalog renameTagTemplateFieldEnumValue Sample", + "origin": "API_DEFINITION", + "description": " Renames an enum value in a tag template. Within a single enum field, enum values must be unique.", + "canonical": true, + "file": "data_catalog.rename_tag_template_field_enum_value.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RenameTagTemplateFieldEnumValue", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "new_enum_value_display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "RenameTagTemplateFieldEnumValue", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTagTemplateField_async", + "title": "DataCatalog deleteTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Deletes a field in a tag template and all uses of this field from the tags based on this template. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).", + "canonical": true, + "file": "data_catalog.delete_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTagTemplateField", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_CreateTag_async", + "title": "DataCatalog createTag Sample", + "origin": "API_DEFINITION", + "description": " Creates a tag and assigns it to: * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is `projects.locations.entryGroups.entries.tags.create`. * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is `projects.locations.entryGroups.tags.create`. Note: The project identified by the `parent` parameter for the [tag] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template] (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be in the same organization.", + "canonical": true, + "file": "data_catalog.create_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTag", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag", + "type": ".google.cloud.datacatalog.v1.Tag" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Tag", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.CreateTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UpdateTag_async", + "title": "DataCatalog updateTag Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing tag.", + "canonical": true, + "file": "data_catalog.update_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTag", + "async": true, + "parameters": [ + { + "name": "tag", + "type": ".google.cloud.datacatalog.v1.Tag" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Tag", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UpdateTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_DeleteTag_async", + "title": "DataCatalog deleteTag Sample", + "origin": "API_DEFINITION", + "description": " Deletes a tag.", + "canonical": true, + "file": "data_catalog.delete_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTag", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.DeleteTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ListTags_async", + "title": "DataCatalog listTags Sample", + "origin": "API_DEFINITION", + "description": " Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.", + "canonical": true, + "file": "data_catalog.list_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTags", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListTags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ListTagsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ListTags", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ListTags", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ReconcileTags_async", + "title": "DataCatalog reconcileTags Sample", + "origin": "API_DEFINITION", + "description": " `ReconcileTags` creates or updates a list of tags on the entry. If the [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing] parameter is set, the operation deletes tags not included in the input tag list. `ReconcileTags` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.", + "canonical": true, + "file": "data_catalog.reconcile_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 72, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReconcileTags", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ReconcileTags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag_template", + "type": "TYPE_STRING" + }, + { + "name": "force_delete_missing", + "type": "TYPE_BOOL" + }, + { + "name": "tags", + "type": "TYPE_MESSAGE[]" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ReconcileTags", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ReconcileTags", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_StarEntry_async", + "title": "DataCatalog starEntry Sample", + "origin": "API_DEFINITION", + "description": " Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.", + "canonical": true, + "file": "data_catalog.star_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "StarEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.StarEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.StarEntryResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "StarEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.StarEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_UnstarEntry_async", + "title": "DataCatalog unstarEntry Sample", + "origin": "API_DEFINITION", + "description": " Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.", + "canonical": true, + "file": "data_catalog.unstar_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UnstarEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UnstarEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.UnstarEntryResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "UnstarEntry", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.UnstarEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_SetIamPolicy_async", + "title": "DataCatalog setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", + "canonical": true, + "file": "data_catalog.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.SetIamPolicy", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_GetIamPolicy_async", + "title": "DataCatalog getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", + "canonical": true, + "file": "data_catalog.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.GetIamPolicy", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_TestIamPermissions_async", + "title": "DataCatalog testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.", + "canonical": true, + "file": "data_catalog.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.TestIamPermissions", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_DataCatalog_ImportEntries_async", + "title": "DataCatalog importEntries Sample", + "origin": "API_DEFINITION", + "description": " Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type. `ImportEntries` returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.", + "canonical": true, + "file": "data_catalog.import_entries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportEntries", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ImportEntries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "gcs_bucket_path", + "type": "TYPE_STRING" + }, + { + "name": "job_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1.DataCatalogClient" + }, + "method": { + "shortName": "ImportEntries", + "fullName": "google.cloud.datacatalog.v1.DataCatalog.ImportEntries", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_CreateTaxonomy_async", + "title": "DataCatalog createTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Creates a taxonomy in a specified project. The taxonomy is initially empty, that is, it doesn't contain policy tags.", + "canonical": true, + "file": "policy_tag_manager.create_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "taxonomy", + "type": ".google.cloud.datacatalog.v1.Taxonomy" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "CreateTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreateTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_DeleteTaxonomy_async", + "title": "DataCatalog deleteTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.", + "canonical": true, + "file": "policy_tag_manager.delete_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "DeleteTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeleteTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_UpdateTaxonomy_async", + "title": "DataCatalog updateTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Updates a taxonomy, including its display name, description, and activated policy types.", + "canonical": true, + "file": "policy_tag_manager.update_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy", + "async": true, + "parameters": [ + { + "name": "taxonomy", + "type": ".google.cloud.datacatalog.v1.Taxonomy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "UpdateTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdateTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_ListTaxonomies_async", + "title": "DataCatalog listTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Lists all taxonomies in a project in a particular location that you have a permission to view.", + "canonical": true, + "file": "policy_tag_manager.list_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies", + "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.datacatalog.v1.ListTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "ListTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListTaxonomies", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_GetTaxonomy_async", + "title": "DataCatalog getTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Gets a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.get_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_CreatePolicyTag_async", + "title": "DataCatalog createPolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Creates a policy tag in a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.create_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "policy_tag", + "type": ".google.cloud.datacatalog.v1.PolicyTag" + } + ], + "resultType": ".google.cloud.datacatalog.v1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "CreatePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.CreatePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_DeletePolicyTag_async", + "title": "DataCatalog deletePolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Deletes a policy tag together with the following: * All of its descendant policy tags, if any * Policies associated with the policy tag and its descendants * References from BigQuery table schema of the policy tag and its descendants", + "canonical": true, + "file": "policy_tag_manager.delete_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "DeletePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.DeletePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_UpdatePolicyTag_async", + "title": "DataCatalog updatePolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Updates a policy tag, including its display name, description, and parent policy tag.", + "canonical": true, + "file": "policy_tag_manager.update_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag", + "async": true, + "parameters": [ + { + "name": "policy_tag", + "type": ".google.cloud.datacatalog.v1.PolicyTag" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "UpdatePolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.UpdatePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_ListPolicyTags_async", + "title": "DataCatalog listPolicyTags Sample", + "origin": "API_DEFINITION", + "description": " Lists all policy tags in a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.list_policy_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPolicyTags", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ListPolicyTagsResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "ListPolicyTags", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.ListPolicyTags", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_GetPolicyTag_async", + "title": "DataCatalog getPolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Gets a policy tag.", + "canonical": true, + "file": "policy_tag_manager.get_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetPolicyTag", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetPolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_GetIamPolicy_async", + "title": "DataCatalog getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy for a policy tag or a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.GetIamPolicy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_SetIamPolicy_async", + "title": "DataCatalog setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy for a policy tag or a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.SetIamPolicy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManager_TestIamPermissions_async", + "title": "DataCatalog testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns your permissions on a specified policy tag or taxonomy.", + "canonical": true, + "file": "policy_tag_manager.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager.TestIamPermissions", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ReplaceTaxonomy_async", + "title": "DataCatalog replaceTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Replaces (updates) a taxonomy and all its policy tags. The taxonomy and its entire hierarchy of policy tags must be represented literally by `SerializedTaxonomy` and the nested `SerializedPolicyTag` messages. This operation automatically does the following: - Deletes the existing policy tags that are missing from the `SerializedPolicyTag`. - Creates policy tags that don't have resource names. They are considered new. - Updates policy tags with valid resources names accordingly.", + "canonical": true, + "file": "policy_tag_manager_serialization.replace_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReplaceTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "serialized_taxonomy", + "type": ".google.cloud.datacatalog.v1.SerializedTaxonomy" + } + ], + "resultType": ".google.cloud.datacatalog.v1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerSerializationClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient" + }, + "method": { + "shortName": "ReplaceTaxonomy", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ReplaceTaxonomy", + "service": { + "shortName": "PolicyTagManagerSerialization", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ImportTaxonomies_async", + "title": "DataCatalog importTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources. For a cross-regional source, new taxonomies are created by copying from a source in another region. For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.", + "canonical": true, + "file": "policy_tag_manager_serialization.import_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "inline_source", + "type": ".google.cloud.datacatalog.v1.InlineSource" + }, + { + "name": "cross_regional_source", + "type": ".google.cloud.datacatalog.v1.CrossRegionalSource" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ImportTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerSerializationClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient" + }, + "method": { + "shortName": "ImportTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ImportTaxonomies", + "service": { + "shortName": "PolicyTagManagerSerialization", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization" + } + } + } + }, + { + "regionTag": "datacatalog_v1_generated_PolicyTagManagerSerialization_ExportTaxonomies_async", + "title": "DataCatalog exportTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project. This method generates `SerializedTaxonomy` protocol buffers with nested policy tags that can be used as input for `ImportTaxonomies` calls.", + "canonical": true, + "file": "policy_tag_manager_serialization.export_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "taxonomies", + "type": "TYPE_STRING[]" + }, + { + "name": "serialized_taxonomies", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.datacatalog.v1.ExportTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerSerializationClient", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerializationClient" + }, + "method": { + "shortName": "ExportTaxonomies", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization.ExportTaxonomies", + "service": { + "shortName": "PolicyTagManagerSerialization", + "fullName": "google.cloud.datacatalog.v1.PolicyTagManagerSerialization" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datacatalog/samples/generated/v1beta1/data_catalog.test_iam_permissions.js b/packages/google-cloud-datacatalog/samples/generated/v1beta1/data_catalog.test_iam_permissions.js index 3414320ddd3..47a8edf0fee 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1beta1/data_catalog.test_iam_permissions.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1beta1/data_catalog.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datacatalog library const {DataCatalogClient} = require('@google-cloud/datacatalog').v1beta1; diff --git a/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager.test_iam_permissions.js b/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager.test_iam_permissions.js index 59ee3a6f674..e70eb71a667 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager.test_iam_permissions.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager.test_iam_permissions.js @@ -39,7 +39,7 @@ function main(resource, permissions) { * information see * IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). */ - // const permissions = 'abc123' + // const permissions = ['abc','def'] // Imports the Datacatalog library const {PolicyTagManagerClient} = require('@google-cloud/datacatalog').v1beta1; diff --git a/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager_serialization.export_taxonomies.js b/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager_serialization.export_taxonomies.js index 18341d62e4b..c4947511078 100644 --- a/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager_serialization.export_taxonomies.js +++ b/packages/google-cloud-datacatalog/samples/generated/v1beta1/policy_tag_manager_serialization.export_taxonomies.js @@ -36,7 +36,7 @@ function main(parent, taxonomies) { /** * Required. Resource names of the taxonomies to be exported. */ - // const taxonomies = 'abc123' + // const taxonomies = ['abc','def'] /** * Export taxonomies as serialized taxonomies. */ diff --git a/packages/google-cloud-datacatalog/samples/generated/v1beta1/snippet_metadata_google.cloud.datacatalog.v1beta1.json b/packages/google-cloud-datacatalog/samples/generated/v1beta1/snippet_metadata_google.cloud.datacatalog.v1beta1.json new file mode 100644 index 00000000000..cf02fad6567 --- /dev/null +++ b/packages/google-cloud-datacatalog/samples/generated/v1beta1/snippet_metadata_google.cloud.datacatalog.v1beta1.json @@ -0,0 +1,1947 @@ +{ + "clientLibrary": { + "name": "nodejs-datacatalog", + "version": "3.5.0", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datacatalog.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_SearchCatalog_async", + "title": "DataCatalog searchCatalog Sample", + "origin": "API_DEFINITION", + "description": " Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call `Get` methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.", + "canonical": true, + "file": "data_catalog.search_catalog.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 95, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog", + "async": true, + "parameters": [ + { + "name": "scope", + "type": ".google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope" + }, + { + "name": "query", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.SearchCatalogResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "SearchCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_CreateEntryGroup_async", + "title": "DataCatalog createEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.create_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntryGroup", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entry_group_id", + "type": "TYPE_STRING" + }, + { + "name": "entry_group", + "type": ".google.cloud.datacatalog.v1beta1.EntryGroup" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "CreateEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_UpdateEntryGroup_async", + "title": "DataCatalog updateEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.update_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntryGroup", + "async": true, + "parameters": [ + { + "name": "entry_group", + "type": ".google.cloud.datacatalog.v1beta1.EntryGroup" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_GetEntryGroup_async", + "title": "DataCatalog getEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Gets an EntryGroup.", + "canonical": true, + "file": "data_catalog.get_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetEntryGroup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.EntryGroup", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "GetEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_DeleteEntryGroup_async", + "title": "DataCatalog deleteEntryGroup Sample", + "origin": "API_DEFINITION", + "description": " Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.delete_entry_group.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntryGroup", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteEntryGroup", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntryGroup", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_ListEntryGroups_async", + "title": "DataCatalog listEntryGroups Sample", + "origin": "API_DEFINITION", + "description": " Lists entry groups.", + "canonical": true, + "file": "data_catalog.list_entry_groups.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntryGroups", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ListEntryGroupsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "ListEntryGroups", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListEntryGroups", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_CreateEntry_async", + "title": "DataCatalog createEntry Sample", + "origin": "API_DEFINITION", + "description": " Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group.", + "canonical": true, + "file": "data_catalog.create_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "entry_id", + "type": "TYPE_STRING" + }, + { + "name": "entry", + "type": ".google.cloud.datacatalog.v1beta1.Entry" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "CreateEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_UpdateEntry_async", + "title": "DataCatalog updateEntry Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.update_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntry", + "async": true, + "parameters": [ + { + "name": "entry", + "type": ".google.cloud.datacatalog.v1beta1.Entry" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_DeleteEntry_async", + "title": "DataCatalog deleteEntry Sample", + "origin": "API_DEFINITION", + "description": " Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.delete_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_GetEntry_async", + "title": "DataCatalog getEntry Sample", + "origin": "API_DEFINITION", + "description": " Gets an entry.", + "canonical": true, + "file": "data_catalog.get_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "GetEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_LookupEntry_async", + "title": "DataCatalog lookupEntry Sample", + "origin": "API_DEFINITION", + "description": " Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.", + "canonical": true, + "file": "data_catalog.lookup_entry.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LookupEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry", + "async": true, + "parameters": [ + { + "name": "linked_resource", + "type": "TYPE_STRING" + }, + { + "name": "sql_resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Entry", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "LookupEntry", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.LookupEntry", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_ListEntries_async", + "title": "DataCatalog listEntries Sample", + "origin": "API_DEFINITION", + "description": " Lists entries.", + "canonical": true, + "file": "data_catalog.list_entries.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEntries", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "read_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ListEntriesResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "ListEntries", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListEntries", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_CreateTagTemplate_async", + "title": "DataCatalog createTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.create_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 66, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplate", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_id", + "type": "TYPE_STRING" + }, + { + "name": "tag_template", + "type": ".google.cloud.datacatalog.v1beta1.TagTemplate" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_GetTagTemplate_async", + "title": "DataCatalog getTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Gets a tag template.", + "canonical": true, + "file": "data_catalog.get_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetTagTemplate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "GetTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_UpdateTagTemplate_async", + "title": "DataCatalog updateTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.update_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplate", + "async": true, + "parameters": [ + { + "name": "tag_template", + "type": ".google.cloud.datacatalog.v1beta1.TagTemplate" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplate", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_DeleteTagTemplate_async", + "title": "DataCatalog deleteTagTemplate Sample", + "origin": "API_DEFINITION", + "description": " Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.delete_tag_template.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplate", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTagTemplate", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplate", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_CreateTagTemplateField_async", + "title": "DataCatalog createTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.create_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplateField", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field_id", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field", + "type": ".google.cloud.datacatalog.v1beta1.TagTemplateField" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_UpdateTagTemplateField_async", + "title": "DataCatalog updateTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.update_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "tag_template_field", + "type": ".google.cloud.datacatalog.v1beta1.TagTemplateField" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_RenameTagTemplateField_async", + "title": "DataCatalog renameTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.rename_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RenameTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "new_tag_template_field_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "RenameTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_RenameTagTemplateFieldEnumValue_async", + "title": "DataCatalog renameTagTemplateFieldEnumValue Sample", + "origin": "API_DEFINITION", + "description": " Renames an enum value in a tag template. The enum values have to be unique within one enum field. Thus, an enum value cannot be renamed with a name used in any other enum value within the same enum field.", + "canonical": true, + "file": "data_catalog.rename_tag_template_field_enum_value.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RenameTagTemplateFieldEnumValue", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateFieldEnumValue", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "new_enum_value_display_name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.TagTemplateField", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "RenameTagTemplateFieldEnumValue", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.RenameTagTemplateFieldEnumValue", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_DeleteTagTemplateField_async", + "title": "DataCatalog deleteTagTemplateField Sample", + "origin": "API_DEFINITION", + "description": " Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information).", + "canonical": true, + "file": "data_catalog.delete_tag_template_field.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplateField", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTagTemplateField", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTagTemplateField", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_CreateTag_async", + "title": "DataCatalog createTag Sample", + "origin": "API_DEFINITION", + "description": " Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry]. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization.", + "canonical": true, + "file": "data_catalog.create_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTag", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "tag", + "type": ".google.cloud.datacatalog.v1beta1.Tag" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Tag", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "CreateTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.CreateTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_UpdateTag_async", + "title": "DataCatalog updateTag Sample", + "origin": "API_DEFINITION", + "description": " Updates an existing tag.", + "canonical": true, + "file": "data_catalog.update_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTag", + "async": true, + "parameters": [ + { + "name": "tag", + "type": ".google.cloud.datacatalog.v1beta1.Tag" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Tag", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "UpdateTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.UpdateTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_DeleteTag_async", + "title": "DataCatalog deleteTag Sample", + "origin": "API_DEFINITION", + "description": " Deletes a tag.", + "canonical": true, + "file": "data_catalog.delete_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "DeleteTag", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.DeleteTag", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_ListTags_async", + "title": "DataCatalog listTags Sample", + "origin": "API_DEFINITION", + "description": " Lists tags assigned to an [Entry][google.cloud.datacatalog.v1beta1.Entry]. The [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response are lowercased.", + "canonical": true, + "file": "data_catalog.list_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTags", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListTags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ListTagsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "ListTags", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.ListTags", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_SetIamPolicy_async", + "title": "DataCatalog setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups.", + "canonical": true, + "file": "data_catalog.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.SetIamPolicy", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_GetIamPolicy_async", + "title": "DataCatalog getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the access control policy for a resource. A `NOT_FOUND` error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entries.getIamPolicy` to get policies on entries. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.", + "canonical": true, + "file": "data_catalog.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.GetIamPolicy", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_DataCatalog_TestIamPermissions_async", + "title": "DataCatalog testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a `NOT_FOUND` error). Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog. A caller is not required to have Google IAM permission to make this request.", + "canonical": true, + "file": "data_catalog.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "DataCatalogClient", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalogClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog.TestIamPermissions", + "service": { + "shortName": "DataCatalog", + "fullName": "google.cloud.datacatalog.v1beta1.DataCatalog" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_CreateTaxonomy_async", + "title": "DataCatalog createTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Creates a taxonomy in the specified project.", + "canonical": true, + "file": "policy_tag_manager.create_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "taxonomy", + "type": ".google.cloud.datacatalog.v1beta1.Taxonomy" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "CreateTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_DeleteTaxonomy_async", + "title": "DataCatalog deleteTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Deletes a taxonomy. This operation will also delete all policy tags in this taxonomy along with their associated policies.", + "canonical": true, + "file": "policy_tag_manager.delete_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "DeleteTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_UpdateTaxonomy_async", + "title": "DataCatalog updateTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Updates a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.update_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy", + "async": true, + "parameters": [ + { + "name": "taxonomy", + "type": ".google.cloud.datacatalog.v1beta1.Taxonomy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "UpdateTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_ListTaxonomies_async", + "title": "DataCatalog listTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Lists all taxonomies in a project in a particular location that the caller has permission to view.", + "canonical": true, + "file": "policy_tag_manager.list_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 70, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies", + "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.datacatalog.v1beta1.ListTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "ListTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_GetTaxonomy_async", + "title": "DataCatalog getTaxonomy Sample", + "origin": "API_DEFINITION", + "description": " Gets a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.get_taxonomy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.Taxonomy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetTaxonomy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_CreatePolicyTag_async", + "title": "DataCatalog createPolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Creates a policy tag in the specified taxonomy.", + "canonical": true, + "file": "policy_tag_manager.create_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreatePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "policy_tag", + "type": ".google.cloud.datacatalog.v1beta1.PolicyTag" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "CreatePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_DeletePolicyTag_async", + "title": "DataCatalog deletePolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Deletes a policy tag. Also deletes all of its descendant policy tags.", + "canonical": true, + "file": "policy_tag_manager.delete_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeletePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "DeletePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_UpdatePolicyTag_async", + "title": "DataCatalog updatePolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Updates a policy tag.", + "canonical": true, + "file": "policy_tag_manager.update_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdatePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag", + "async": true, + "parameters": [ + { + "name": "policy_tag", + "type": ".google.cloud.datacatalog.v1beta1.PolicyTag" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "UpdatePolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_ListPolicyTags_async", + "title": "DataCatalog listPolicyTags Sample", + "origin": "API_DEFINITION", + "description": " Lists all policy tags in a taxonomy.", + "canonical": true, + "file": "policy_tag_manager.list_policy_tags.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListPolicyTags", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ListPolicyTagsResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "ListPolicyTags", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_GetPolicyTag_async", + "title": "DataCatalog getPolicyTag Sample", + "origin": "API_DEFINITION", + "description": " Gets a policy tag.", + "canonical": true, + "file": "policy_tag_manager.get_policy_tag.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetPolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.PolicyTag", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetPolicyTag", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_GetIamPolicy_async", + "title": "DataCatalog getIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Gets the IAM policy for a taxonomy or a policy tag.", + "canonical": true, + "file": "policy_tag_manager.get_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "options", + "type": ".google.iam.v1.GetPolicyOptions" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "GetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.GetIamPolicy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_SetIamPolicy_async", + "title": "DataCatalog setIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Sets the IAM policy for a taxonomy or a policy tag.", + "canonical": true, + "file": "policy_tag_manager.set_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.SetIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "policy", + "type": ".google.iam.v1.Policy" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.iam.v1.Policy", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "SetIamPolicy", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.SetIamPolicy", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManager_TestIamPermissions_async", + "title": "DataCatalog testIamPermissions Sample", + "origin": "API_DEFINITION", + "description": " Returns the permissions that a caller has on the specified taxonomy or policy tag.", + "canonical": true, + "file": "policy_tag_manager.test_iam_permissions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.TestIamPermissions", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + }, + { + "name": "permissions", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.iam.v1.TestIamPermissionsResponse", + "client": { + "shortName": "PolicyTagManagerClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerClient" + }, + "method": { + "shortName": "TestIamPermissions", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager.TestIamPermissions", + "service": { + "shortName": "PolicyTagManager", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManager" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManagerSerialization_ImportTaxonomies_async", + "title": "DataCatalog importTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Imports all taxonomies and their policy tags to a project as new taxonomies. This method provides a bulk taxonomy / policy tag creation using nested proto structure.", + "canonical": true, + "file": "policy_tag_manager_serialization.import_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "inline_source", + "type": ".google.cloud.datacatalog.v1beta1.InlineSource" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ImportTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerSerializationClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerializationClient" + }, + "method": { + "shortName": "ImportTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies", + "service": { + "shortName": "PolicyTagManagerSerialization", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization" + } + } + } + }, + { + "regionTag": "datacatalog_v1beta1_generated_PolicyTagManagerSerialization_ExportTaxonomies_async", + "title": "DataCatalog exportTaxonomies Sample", + "origin": "API_DEFINITION", + "description": " Exports all taxonomies and their policy tags in a project. This method generates SerializedTaxonomy protos with nested policy tags that can be used as an input for future ImportTaxonomies calls.", + "canonical": true, + "file": "policy_tag_manager_serialization.export_taxonomies.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "taxonomies", + "type": "TYPE_STRING[]" + }, + { + "name": "serialized_taxonomies", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.datacatalog.v1beta1.ExportTaxonomiesResponse", + "client": { + "shortName": "PolicyTagManagerSerializationClient", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerializationClient" + }, + "method": { + "shortName": "ExportTaxonomies", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies", + "service": { + "shortName": "PolicyTagManagerSerialization", + "fullName": "google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datacatalog/samples/package.json b/packages/google-cloud-datacatalog/samples/package.json index 1336cd1bd3f..3b12c34c128 100644 --- a/packages/google-cloud-datacatalog/samples/package.json +++ b/packages/google-cloud-datacatalog/samples/package.json @@ -4,7 +4,7 @@ "license": "Apache-2.0", "author": "Google LLC", "engines": { - "node": ">=12.0.0" + "node": ">=14.0.0" }, "repository": "googleapis/nodejs-datacatalog", "private": true, @@ -24,4 +24,4 @@ "execa": "^7.0.0", "mocha": "^8.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-datacatalog/src/v1/data_catalog_client.ts b/packages/google-cloud-datacatalog/src/v1/data_catalog_client.ts index 1fdd9ce4698..94953baa844 100644 --- a/packages/google-cloud-datacatalog/src/v1/data_catalog_client.ts +++ b/packages/google-cloud-datacatalog/src/v1/data_catalog_client.ts @@ -513,9 +513,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1.EntryGroup|EntryGroup}. + * 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/data_catalog.create_entry_group.js * region_tag:datacatalog_v1_generated_DataCatalog_CreateEntryGroup_async @@ -606,9 +605,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1.EntryGroup|EntryGroup}. + * 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/data_catalog.get_entry_group.js * region_tag:datacatalog_v1_generated_DataCatalog_GetEntryGroup_async @@ -708,9 +706,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1.EntryGroup|EntryGroup}. + * 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/data_catalog.update_entry_group.js * region_tag:datacatalog_v1_generated_DataCatalog_UpdateEntryGroup_async @@ -806,9 +803,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_entry_group.js * region_tag:datacatalog_v1_generated_DataCatalog_DeleteEntryGroup_async @@ -918,9 +914,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. - * 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.datacatalog.v1.Entry|Entry}. + * 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/data_catalog.create_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_CreateEntry_async @@ -1038,9 +1033,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. - * 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.datacatalog.v1.Entry|Entry}. + * 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/data_catalog.update_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_UpdateEntry_async @@ -1117,7 +1111,7 @@ export class DataCatalogClient { * Deletes an existing entry. * * You can delete only the entries created by the - * {@link google.cloud.datacatalog.v1.DataCatalog.CreateEntry|CreateEntry} + * {@link protos.google.cloud.datacatalog.v1.DataCatalog.CreateEntry|CreateEntry} * method. * * You must enable the Data Catalog API in the project identified by @@ -1132,9 +1126,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_DeleteEntry_async @@ -1217,9 +1210,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. - * 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.datacatalog.v1.Entry|Entry}. + * 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/data_catalog.get_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_GetEntry_async @@ -1351,9 +1343,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. - * 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.datacatalog.v1.Entry|Entry}. + * 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/data_catalog.lookup_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_LookupEntry_async @@ -1424,7 +1415,7 @@ export class DataCatalogClient { } /** * Modifies entry overview, part of the business context of an - * {@link google.cloud.datacatalog.v1.Entry|Entry}. + * {@link protos.google.cloud.datacatalog.v1.Entry|Entry}. * * To call this method, you must have the `datacatalog.entries.updateOverview` * IAM permission on the corresponding project. @@ -1438,9 +1429,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryOverview | EntryOverview}. - * 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.datacatalog.v1.EntryOverview|EntryOverview}. + * 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/data_catalog.modify_entry_overview.js * region_tag:datacatalog_v1_generated_DataCatalog_ModifyEntryOverview_async @@ -1527,7 +1517,7 @@ export class DataCatalogClient { } /** * Modifies contacts, part of the business context of an - * {@link google.cloud.datacatalog.v1.Entry|Entry}. + * {@link protos.google.cloud.datacatalog.v1.Entry|Entry}. * * To call this method, you must have the `datacatalog.entries.updateContacts` * IAM permission on the corresponding project. @@ -1541,9 +1531,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Contacts | Contacts}. - * 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.datacatalog.v1.Contacts|Contacts}. + * 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/data_catalog.modify_entry_contacts.js * region_tag:datacatalog_v1_generated_DataCatalog_ModifyEntryContacts_async @@ -1652,9 +1641,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1.TagTemplate|TagTemplate}. + * 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/data_catalog.create_tag_template.js * region_tag:datacatalog_v1_generated_DataCatalog_CreateTagTemplate_async @@ -1743,9 +1731,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1.TagTemplate|TagTemplate}. + * 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/data_catalog.get_tag_template.js * region_tag:datacatalog_v1_generated_DataCatalog_GetTagTemplate_async @@ -1852,9 +1839,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1.TagTemplate|TagTemplate}. + * 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/data_catalog.update_tag_template.js * region_tag:datacatalog_v1_generated_DataCatalog_UpdateTagTemplate_async @@ -1951,9 +1937,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag_template.js * region_tag:datacatalog_v1_generated_DataCatalog_DeleteTagTemplate_async @@ -2058,9 +2043,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.create_tag_template_field.js * region_tag:datacatalog_v1_generated_DataCatalog_CreateTagTemplateField_async @@ -2185,9 +2169,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.update_tag_template_field.js * region_tag:datacatalog_v1_generated_DataCatalog_UpdateTagTemplateField_async @@ -2293,9 +2276,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.rename_tag_template_field.js * region_tag:datacatalog_v1_generated_DataCatalog_RenameTagTemplateField_async @@ -2399,9 +2381,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.rename_tag_template_field_enum_value.js * region_tag:datacatalog_v1_generated_DataCatalog_RenameTagTemplateFieldEnumValue_async @@ -2509,9 +2490,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag_template_field.js * region_tag:datacatalog_v1_generated_DataCatalog_DeleteTagTemplateField_async @@ -2603,9 +2583,9 @@ export class DataCatalogClient { /** * Creates a tag and assigns it to: * - * * An {@link google.cloud.datacatalog.v1.Entry|Entry} if the method name is + * * An {@link protos.google.cloud.datacatalog.v1.Entry|Entry} if the method name is * `projects.locations.entryGroups.entries.tags.create`. - * * Or {@link google.cloud.datacatalog.v1.EntryGroup|EntryGroup}if the method + * * Or {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup}if the method * name is `projects.locations.entryGroups.tags.create`. * * Note: The project identified by the `parent` parameter for the [tag] @@ -2629,9 +2609,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Tag | Tag}. - * 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.datacatalog.v1.Tag|Tag}. + * 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/data_catalog.create_tag.js * region_tag:datacatalog_v1_generated_DataCatalog_CreateTag_async @@ -2721,9 +2700,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.Tag | Tag}. - * 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.datacatalog.v1.Tag|Tag}. + * 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/data_catalog.update_tag.js * region_tag:datacatalog_v1_generated_DataCatalog_UpdateTag_async @@ -2806,9 +2784,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag.js * region_tag:datacatalog_v1_generated_DataCatalog_DeleteTag_async @@ -2882,7 +2859,7 @@ export class DataCatalogClient { return this.innerApiCalls.deleteTag(request, options, callback); } /** - * Marks an {@link google.cloud.datacatalog.v1.Entry|Entry} as starred by + * Marks an {@link protos.google.cloud.datacatalog.v1.Entry|Entry} as starred by * the current user. Starring information is private to each user. * * @param {Object} request @@ -2892,9 +2869,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.StarEntryResponse | StarEntryResponse}. - * 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.datacatalog.v1.StarEntryResponse|StarEntryResponse}. + * 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/data_catalog.star_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_StarEntry_async @@ -2968,7 +2944,7 @@ export class DataCatalogClient { return this.innerApiCalls.starEntry(request, options, callback); } /** - * Marks an {@link google.cloud.datacatalog.v1.Entry|Entry} as NOT starred by + * Marks an {@link protos.google.cloud.datacatalog.v1.Entry|Entry} as NOT starred by * the current user. Starring information is private to each user. * * @param {Object} request @@ -2978,9 +2954,8 @@ export class DataCatalogClient { * @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.datacatalog.v1.UnstarEntryResponse | UnstarEntryResponse}. - * 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.datacatalog.v1.UnstarEntryResponse|UnstarEntryResponse}. + * 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/data_catalog.unstar_entry.js * region_tag:datacatalog_v1_generated_DataCatalog_UnstarEntry_async @@ -3091,9 +3066,8 @@ export class DataCatalogClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_catalog.set_iam_policy.js * region_tag:datacatalog_v1_generated_DataCatalog_SetIamPolicy_async @@ -3198,9 +3172,8 @@ export class DataCatalogClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_catalog.get_iam_policy.js * region_tag:datacatalog_v1_generated_DataCatalog_GetIamPolicy_async @@ -3300,9 +3273,8 @@ export class DataCatalogClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/data_catalog.test_iam_permissions.js * region_tag:datacatalog_v1_generated_DataCatalog_TestIamPermissions_async @@ -3377,13 +3349,13 @@ export class DataCatalogClient { /** * `ReconcileTags` creates or updates a list of tags on the entry. * If the - * {@link google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing|ReconcileTagsRequest.force_delete_missing} + * {@link protos.google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing|ReconcileTagsRequest.force_delete_missing} * parameter is set, the operation deletes tags not included in the input tag * list. * * `ReconcileTags` returns a [long-running operation] * [google.longrunning.Operation] resource that can be queried with - * {@link google.longrunning.Operations.GetOperation|Operations.GetOperation} + * {@link protos.google.longrunning.Operations.GetOperation|Operations.GetOperation} * to return [ReconcileTagsMetadata] * [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and * a [ReconcileTagsResponse] @@ -3392,7 +3364,7 @@ export class DataCatalogClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. Name of {@link google.cloud.datacatalog.v1.Entry|Entry} to be tagged. + * Required. Name of {@link protos.google.cloud.datacatalog.v1.Entry|Entry} to be tagged. * @param {string} request.tagTemplate * Required. The name of the tag template, which is used for reconciliation. * @param {boolean} request.forceDeleteMissing @@ -3410,8 +3382,7 @@ export class DataCatalogClient { * 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/data_catalog.reconcile_tags.js * region_tag:datacatalog_v1_generated_DataCatalog_ReconcileTags_async @@ -3506,8 +3477,7 @@ export class DataCatalogClient { * 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/data_catalog.reconcile_tags.js * region_tag:datacatalog_v1_generated_DataCatalog_ReconcileTags_async @@ -3544,15 +3514,15 @@ export class DataCatalogClient { * `ImportEntries` accepts source data snapshots of a third-party system. * Snapshot should be delivered as a .wire or base65-encoded .txt file * containing a sequence of Protocol Buffer messages of - * {@link google.cloud.datacatalog.v1.DumpItem|DumpItem} type. + * {@link protos.google.cloud.datacatalog.v1.DumpItem|DumpItem} type. * * `ImportEntries` returns a [long-running operation] * [google.longrunning.Operation] resource that can be queried with - * {@link google.longrunning.Operations.GetOperation|Operations.GetOperation} + * {@link protos.google.longrunning.Operations.GetOperation|Operations.GetOperation} * to return - * {@link google.cloud.datacatalog.v1.ImportEntriesMetadata|ImportEntriesMetadata} + * {@link protos.google.cloud.datacatalog.v1.ImportEntriesMetadata|ImportEntriesMetadata} * and an - * {@link google.cloud.datacatalog.v1.ImportEntriesResponse|ImportEntriesResponse} + * {@link protos.google.cloud.datacatalog.v1.ImportEntriesResponse|ImportEntriesResponse} * message. * * @param {Object} request @@ -3570,8 +3540,7 @@ export class DataCatalogClient { * 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/data_catalog.import_entries.js * region_tag:datacatalog_v1_generated_DataCatalog_ImportEntries_async @@ -3666,8 +3635,7 @@ export class DataCatalogClient { * 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/data_catalog.import_entries.js * region_tag:datacatalog_v1_generated_DataCatalog_ImportEntries_async @@ -3744,9 +3712,9 @@ export class DataCatalogClient { * search results. If empty, returns the first page. * * This token is returned in the - * {@link google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} + * {@link protos.google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} * field of the response to a previous - * {@link google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call. * @param {string} request.orderBy * Specifies the order of results. @@ -3768,14 +3736,13 @@ export class DataCatalogClient { * @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.datacatalog.v1.SearchCatalogResult | SearchCatalogResult}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.SearchCatalogResult|SearchCatalogResult}. * 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 `searchCatalogAsync()` * 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. */ searchCatalog( @@ -3883,9 +3850,9 @@ export class DataCatalogClient { * search results. If empty, returns the first page. * * This token is returned in the - * {@link google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} + * {@link protos.google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} * field of the response to a previous - * {@link google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call. * @param {string} request.orderBy * Specifies the order of results. @@ -3907,13 +3874,12 @@ export class DataCatalogClient { * @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.datacatalog.v1.SearchCatalogResult | SearchCatalogResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.SearchCatalogResult|SearchCatalogResult} 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 `searchCatalogAsync()` * 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. */ searchCatalogStream( @@ -3970,9 +3936,9 @@ export class DataCatalogClient { * search results. If empty, returns the first page. * * This token is returned in the - * {@link google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} + * {@link protos.google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token} * field of the response to a previous - * {@link google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call. * @param {string} request.orderBy * Specifies the order of results. @@ -3994,12 +3960,11 @@ export class DataCatalogClient { * @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.datacatalog.v1.SearchCatalogResult | SearchCatalogResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.SearchCatalogResult|SearchCatalogResult}. 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/data_catalog.search_catalog.js * region_tag:datacatalog_v1_generated_DataCatalog_SearchCatalog_async @@ -4041,14 +4006,13 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup}. * 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 `listEntryGroupsAsync()` * 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. */ listEntryGroups( @@ -4145,13 +4109,12 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup} 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 `listEntryGroupsAsync()` * 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. */ listEntryGroupsStream( @@ -4197,12 +4160,11 @@ export class DataCatalogClient { * @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.datacatalog.v1.EntryGroup | EntryGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup}. 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/data_catalog.list_entry_groups.js * region_tag:datacatalog_v1_generated_DataCatalog_ListEntryGroups_async @@ -4233,7 +4195,7 @@ export class DataCatalogClient { * * Note: Currently, this method can list only custom entries. * To get a list of both custom and automatically created entries, use - * {@link google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalog}. + * {@link protos.google.cloud.datacatalog.v1.DataCatalog.SearchCatalog|SearchCatalog}. * * @param {Object} request * The request object that will be sent. @@ -4256,14 +4218,13 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.Entry|Entry}. * 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 `listEntriesAsync()` * 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. */ listEntries( @@ -4364,13 +4325,12 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.Entry|Entry} 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 `listEntriesAsync()` * 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. */ listEntriesStream( @@ -4420,12 +4380,11 @@ export class DataCatalogClient { * @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.datacatalog.v1.Entry | Entry}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.Entry|Entry}. 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/data_catalog.list_entries.js * region_tag:datacatalog_v1_generated_DataCatalog_ListEntries_async @@ -4452,8 +4411,8 @@ export class DataCatalogClient { ) as AsyncIterable; } /** - * Lists tags assigned to an {@link google.cloud.datacatalog.v1.Entry|Entry}. - * The {@link google.cloud.datacatalog.v1.Tag.column|columns} in the response are + * Lists tags assigned to an {@link protos.google.cloud.datacatalog.v1.Entry|Entry}. + * The {@link protos.google.cloud.datacatalog.v1.Tag.column|columns} in the response are * lowercased. * * @param {Object} request @@ -4461,8 +4420,8 @@ export class DataCatalogClient { * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. * - * The resource can be an {@link google.cloud.datacatalog.v1.Entry|Entry} - * or an {@link google.cloud.datacatalog.v1.EntryGroup|EntryGroup} + * The resource can be an {@link protos.google.cloud.datacatalog.v1.Entry|Entry} + * or an {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup} * (without `/entries/{entries}` at the end). * @param {number} request.pageSize * The maximum number of tags to return. Default is 10. Maximum limit is 1000. @@ -4472,14 +4431,13 @@ export class DataCatalogClient { * @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.datacatalog.v1.Tag | Tag}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.Tag|Tag}. * 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 `listTagsAsync()` * 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. */ listTags( @@ -4558,8 +4516,8 @@ export class DataCatalogClient { * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. * - * The resource can be an {@link google.cloud.datacatalog.v1.Entry|Entry} - * or an {@link google.cloud.datacatalog.v1.EntryGroup|EntryGroup} + * The resource can be an {@link protos.google.cloud.datacatalog.v1.Entry|Entry} + * or an {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup} * (without `/entries/{entries}` at the end). * @param {number} request.pageSize * The maximum number of tags to return. Default is 10. Maximum limit is 1000. @@ -4569,13 +4527,12 @@ export class DataCatalogClient { * @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.datacatalog.v1.Tag | Tag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.Tag|Tag} 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 `listTagsAsync()` * 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. */ listTagsStream( @@ -4609,8 +4566,8 @@ export class DataCatalogClient { * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. * - * The resource can be an {@link google.cloud.datacatalog.v1.Entry|Entry} - * or an {@link google.cloud.datacatalog.v1.EntryGroup|EntryGroup} + * The resource can be an {@link protos.google.cloud.datacatalog.v1.Entry|Entry} + * or an {@link protos.google.cloud.datacatalog.v1.EntryGroup|EntryGroup} * (without `/entries/{entries}` at the end). * @param {number} request.pageSize * The maximum number of tags to return. Default is 10. Maximum limit is 1000. @@ -4620,12 +4577,11 @@ export class DataCatalogClient { * @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.datacatalog.v1.Tag | Tag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.Tag|Tag}. 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/data_catalog.list_tags.js * region_tag:datacatalog_v1_generated_DataCatalog_ListTags_async diff --git a/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_client.ts b/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_client.ts index eb998c96b1a..32f5bcf7efa 100644 --- a/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_client.ts +++ b/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_client.ts @@ -385,9 +385,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.create_taxonomy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_CreateTaxonomy_async @@ -480,9 +479,8 @@ export class PolicyTagManagerClient { * @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/policy_tag_manager.delete_taxonomy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_DeleteTaxonomy_async @@ -579,9 +577,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.update_taxonomy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_UpdateTaxonomy_async @@ -670,9 +667,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.get_taxonomy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_GetTaxonomy_async @@ -757,9 +753,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.create_policy_tag.js * region_tag:datacatalog_v1_generated_PolicyTagManager_CreatePolicyTag_async @@ -855,9 +850,8 @@ export class PolicyTagManagerClient { * @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/policy_tag_manager.delete_policy_tag.js * region_tag:datacatalog_v1_generated_PolicyTagManager_DeletePolicyTag_async @@ -955,9 +949,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.update_policy_tag.js * region_tag:datacatalog_v1_generated_PolicyTagManager_UpdatePolicyTag_async @@ -1046,9 +1039,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.get_policy_tag.js * region_tag:datacatalog_v1_generated_PolicyTagManager_GetPolicyTag_async @@ -1141,9 +1133,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/policy_tag_manager.get_iam_policy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_GetIamPolicy_async @@ -1236,9 +1227,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/policy_tag_manager.set_iam_policy.js * region_tag:datacatalog_v1_generated_PolicyTagManager_SetIamPolicy_async @@ -1326,9 +1316,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/policy_tag_manager.test_iam_permissions.js * region_tag:datacatalog_v1_generated_PolicyTagManager_TestIamPermissions_async @@ -1422,14 +1411,13 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.Taxonomy|Taxonomy}. * 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 `listTaxonomiesAsync()` * 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. */ listTaxonomies( @@ -1527,13 +1515,12 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.Taxonomy|Taxonomy} 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 `listTaxonomiesAsync()` * 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. */ listTaxonomiesStream( @@ -1580,12 +1567,11 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.Taxonomy|Taxonomy}. 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/policy_tag_manager.list_taxonomies.js * region_tag:datacatalog_v1_generated_PolicyTagManager_ListTaxonomies_async @@ -1630,14 +1616,13 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1.PolicyTag|PolicyTag}. * 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 `listPolicyTagsAsync()` * 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. */ listPolicyTags( @@ -1733,13 +1718,12 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1.PolicyTag|PolicyTag} 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 `listPolicyTagsAsync()` * 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. */ listPolicyTagsStream( @@ -1784,12 +1768,11 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1.PolicyTag | PolicyTag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1.PolicyTag|PolicyTag}. 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/policy_tag_manager.list_policy_tags.js * region_tag:datacatalog_v1_generated_PolicyTagManager_ListPolicyTags_async diff --git a/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_serialization_client.ts b/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_serialization_client.ts index 24873fae26b..4503a90f790 100644 --- a/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_serialization_client.ts +++ b/packages/google-cloud-datacatalog/src/v1/policy_tag_manager_serialization_client.ts @@ -367,9 +367,8 @@ export class PolicyTagManagerSerializationClient { * @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.datacatalog.v1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager_serialization.replace_taxonomy.js * region_tag:datacatalog_v1_generated_PolicyTagManagerSerialization_ReplaceTaxonomy_async @@ -470,9 +469,8 @@ export class PolicyTagManagerSerializationClient { * @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.datacatalog.v1.ImportTaxonomiesResponse | ImportTaxonomiesResponse}. - * 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.datacatalog.v1.ImportTaxonomiesResponse|ImportTaxonomiesResponse}. + * 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/policy_tag_manager_serialization.import_taxonomies.js * region_tag:datacatalog_v1_generated_PolicyTagManagerSerialization_ImportTaxonomies_async @@ -572,9 +570,8 @@ export class PolicyTagManagerSerializationClient { * @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.datacatalog.v1.ExportTaxonomiesResponse | ExportTaxonomiesResponse}. - * 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.datacatalog.v1.ExportTaxonomiesResponse|ExportTaxonomiesResponse}. + * 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/policy_tag_manager_serialization.export_taxonomies.js * region_tag:datacatalog_v1_generated_PolicyTagManagerSerialization_ExportTaxonomies_async diff --git a/packages/google-cloud-datacatalog/src/v1beta1/data_catalog_client.ts b/packages/google-cloud-datacatalog/src/v1beta1/data_catalog_client.ts index 4f2a5f50883..1d4d10d9648 100644 --- a/packages/google-cloud-datacatalog/src/v1beta1/data_catalog_client.ts +++ b/packages/google-cloud-datacatalog/src/v1beta1/data_catalog_client.ts @@ -422,9 +422,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * 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/data_catalog.create_entry_group.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_CreateEntryGroup_async @@ -529,9 +528,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * 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/data_catalog.update_entry_group.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_UpdateEntryGroup_async @@ -629,9 +627,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup}. - * 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.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * 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/data_catalog.get_entry_group.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_GetEntryGroup_async @@ -727,9 +724,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_entry_group.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_DeleteEntryGroup_async @@ -841,9 +837,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. - * 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.datacatalog.v1beta1.Entry|Entry}. + * 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/data_catalog.create_entry.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_CreateEntry_async @@ -961,9 +956,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. - * 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.datacatalog.v1beta1.Entry|Entry}. + * 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/data_catalog.update_entry.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_UpdateEntry_async @@ -1044,7 +1038,7 @@ export class DataCatalogClient { } /** * Deletes an existing entry. Only entries created through - * {@link google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry|CreateEntry} + * {@link protos.google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry|CreateEntry} * method can be deleted. * Users should enable the Data Catalog API in the project identified by * the `name` parameter (see [Data Catalog Resource Project] @@ -1060,9 +1054,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_entry.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_DeleteEntry_async @@ -1153,9 +1146,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. - * 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.datacatalog.v1beta1.Entry|Entry}. + * 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/data_catalog.get_entry.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_GetEntry_async @@ -1267,9 +1259,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. - * 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.datacatalog.v1beta1.Entry|Entry}. + * 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/data_catalog.lookup_entry.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_LookupEntry_async @@ -1367,9 +1358,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1beta1.TagTemplate|TagTemplate}. + * 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/data_catalog.create_tag_template.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_CreateTagTemplate_async @@ -1466,9 +1456,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1beta1.TagTemplate|TagTemplate}. + * 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/data_catalog.get_tag_template.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_GetTagTemplate_async @@ -1576,9 +1565,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplate | TagTemplate}. - * 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.datacatalog.v1beta1.TagTemplate|TagTemplate}. + * 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/data_catalog.update_tag_template.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_UpdateTagTemplate_async @@ -1683,9 +1671,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag_template.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_DeleteTagTemplate_async @@ -1797,9 +1784,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1beta1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.create_tag_template_field.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_CreateTagTemplateField_async @@ -1923,9 +1909,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1beta1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.update_tag_template_field.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_UpdateTagTemplateField_async @@ -2033,9 +2018,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1beta1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.rename_tag_template_field.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_RenameTagTemplateField_async @@ -2141,9 +2125,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.TagTemplateField | TagTemplateField}. - * 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.datacatalog.v1beta1.TagTemplateField|TagTemplateField}. + * 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/data_catalog.rename_tag_template_field_enum_value.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_RenameTagTemplateFieldEnumValue_async @@ -2252,9 +2235,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag_template_field.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_DeleteTagTemplateField_async @@ -2344,7 +2326,7 @@ export class DataCatalogClient { ); } /** - * Creates a tag on an {@link google.cloud.datacatalog.v1beta1.Entry|Entry}. + * Creates a tag on an {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry}. * Note: The project identified by the `parent` parameter for the * [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) * and the @@ -2367,9 +2349,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Tag | Tag}. - * 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.datacatalog.v1beta1.Tag|Tag}. + * 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/data_catalog.create_tag.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_CreateTag_async @@ -2467,9 +2448,8 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Tag | Tag}. - * 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.datacatalog.v1beta1.Tag|Tag}. + * 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/data_catalog.update_tag.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_UpdateTag_async @@ -2560,9 +2540,8 @@ export class DataCatalogClient { * @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/data_catalog.delete_tag.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_DeleteTag_async @@ -2676,9 +2655,8 @@ export class DataCatalogClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_catalog.set_iam_policy.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_SetIamPolicy_async @@ -2778,9 +2756,8 @@ export class DataCatalogClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/data_catalog.get_iam_policy.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_GetIamPolicy_async @@ -2879,9 +2856,8 @@ export class DataCatalogClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/data_catalog.test_iam_permissions.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_TestIamPermissions_async @@ -2996,9 +2972,9 @@ export class DataCatalogClient { * for page_size is 1000. Throws an invalid argument for page_size > 1000. * @param {string} [request.pageToken] * Optional. Pagination token returned in an earlier - * {@link google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, + * {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, * which indicates that this is a continuation of a prior - * {@link google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call, and that the system should return the next page of data. If empty, * the first page is returned. * @param {string} request.orderBy @@ -3014,14 +2990,13 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.SearchCatalogResult | SearchCatalogResult}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResult|SearchCatalogResult}. * 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 `searchCatalogAsync()` * 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. */ searchCatalog( @@ -3122,9 +3097,9 @@ export class DataCatalogClient { * for page_size is 1000. Throws an invalid argument for page_size > 1000. * @param {string} [request.pageToken] * Optional. Pagination token returned in an earlier - * {@link google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, + * {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, * which indicates that this is a continuation of a prior - * {@link google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call, and that the system should return the next page of data. If empty, * the first page is returned. * @param {string} request.orderBy @@ -3140,13 +3115,12 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.SearchCatalogResult | SearchCatalogResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResult|SearchCatalogResult} 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 `searchCatalogAsync()` * 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. */ searchCatalogStream( @@ -3196,9 +3170,9 @@ export class DataCatalogClient { * for page_size is 1000. Throws an invalid argument for page_size > 1000. * @param {string} [request.pageToken] * Optional. Pagination token returned in an earlier - * {@link google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, + * {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token|SearchCatalogResponse.next_page_token}, * which indicates that this is a continuation of a prior - * {@link google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} + * {@link protos.google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog|SearchCatalogRequest} * call, and that the system should return the next page of data. If empty, * the first page is returned. * @param {string} request.orderBy @@ -3214,12 +3188,11 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.SearchCatalogResult | SearchCatalogResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.SearchCatalogResult|SearchCatalogResult}. 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/data_catalog.search_catalog.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_SearchCatalog_async @@ -3260,14 +3233,13 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. * 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 `listEntryGroupsAsync()` * 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. */ listEntryGroups( @@ -3363,13 +3335,12 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup} 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 `listEntryGroupsAsync()` * 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. */ listEntryGroupsStream( @@ -3414,12 +3385,11 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.EntryGroup | EntryGroup}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. 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/data_catalog.list_entry_groups.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_ListEntryGroups_async @@ -3469,14 +3439,13 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry}. * 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 `listEntriesAsync()` * 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. */ listEntries( @@ -3577,13 +3546,12 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry} 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 `listEntriesAsync()` * 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. */ listEntriesStream( @@ -3633,12 +3601,11 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Entry | Entry}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry}. 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/data_catalog.list_entries.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_ListEntries_async @@ -3665,16 +3632,16 @@ export class DataCatalogClient { ) as AsyncIterable; } /** - * Lists tags assigned to an {@link google.cloud.datacatalog.v1beta1.Entry|Entry}. - * The {@link google.cloud.datacatalog.v1beta1.Tag.column|columns} in the response + * Lists tags assigned to an {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry}. + * The {@link protos.google.cloud.datacatalog.v1beta1.Tag.column|columns} in the response * are lowercased. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. The - * resource could be an {@link google.cloud.datacatalog.v1beta1.Entry|Entry} or an - * {@link google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * resource could be an {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry} or an + * {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. * * Examples: * @@ -3688,14 +3655,13 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Tag | Tag}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.Tag|Tag}. * 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 `listTagsAsync()` * 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. */ listTags( @@ -3779,8 +3745,8 @@ export class DataCatalogClient { * The request object that will be sent. * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. The - * resource could be an {@link google.cloud.datacatalog.v1beta1.Entry|Entry} or an - * {@link google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * resource could be an {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry} or an + * {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. * * Examples: * @@ -3794,13 +3760,12 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Tag | Tag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.Tag|Tag} 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 `listTagsAsync()` * 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. */ listTagsStream( @@ -3833,8 +3798,8 @@ export class DataCatalogClient { * The request object that will be sent. * @param {string} request.parent * Required. The name of the Data Catalog resource to list the tags of. The - * resource could be an {@link google.cloud.datacatalog.v1beta1.Entry|Entry} or an - * {@link google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. + * resource could be an {@link protos.google.cloud.datacatalog.v1beta1.Entry|Entry} or an + * {@link protos.google.cloud.datacatalog.v1beta1.EntryGroup|EntryGroup}. * * Examples: * @@ -3848,12 +3813,11 @@ export class DataCatalogClient { * @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.datacatalog.v1beta1.Tag | Tag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.Tag|Tag}. 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/data_catalog.list_tags.js * region_tag:datacatalog_v1beta1_generated_DataCatalog_ListTags_async diff --git a/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_client.ts b/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_client.ts index f55ef25250d..6f21b13a3de 100644 --- a/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_client.ts +++ b/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_client.ts @@ -380,9 +380,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1beta1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.create_taxonomy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_CreateTaxonomy_async @@ -479,9 +478,8 @@ export class PolicyTagManagerClient { * @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/policy_tag_manager.delete_taxonomy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_DeleteTaxonomy_async @@ -582,9 +580,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1beta1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.update_taxonomy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_UpdateTaxonomy_async @@ -679,9 +676,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy}. - * 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.datacatalog.v1beta1.Taxonomy|Taxonomy}. + * 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/policy_tag_manager.get_taxonomy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_GetTaxonomy_async @@ -772,9 +768,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1beta1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.create_policy_tag.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_CreatePolicyTag_async @@ -870,9 +865,8 @@ export class PolicyTagManagerClient { * @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/policy_tag_manager.delete_policy_tag.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_DeletePolicyTag_async @@ -976,9 +970,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1beta1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.update_policy_tag.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_UpdatePolicyTag_async @@ -1073,9 +1066,8 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag}. - * 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.datacatalog.v1beta1.PolicyTag|PolicyTag}. + * 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/policy_tag_manager.get_policy_tag.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_GetPolicyTag_async @@ -1168,9 +1160,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/policy_tag_manager.get_iam_policy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_GetIamPolicy_async @@ -1263,9 +1254,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.Policy | Policy}. - * 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.iam.v1.Policy|Policy}. + * 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/policy_tag_manager.set_iam_policy.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_SetIamPolicy_async @@ -1353,9 +1343,8 @@ export class PolicyTagManagerClient { * @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.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. - * 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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. + * 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/policy_tag_manager.test_iam_permissions.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_TestIamPermissions_async @@ -1447,14 +1436,13 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.Taxonomy|Taxonomy}. * 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 `listTaxonomiesAsync()` * 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. */ listTaxonomies( @@ -1550,13 +1538,12 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.Taxonomy|Taxonomy} 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 `listTaxonomiesAsync()` * 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. */ listTaxonomiesStream( @@ -1601,12 +1588,11 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.Taxonomy | Taxonomy}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.Taxonomy|Taxonomy}. 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/policy_tag_manager.list_taxonomies.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_ListTaxonomies_async @@ -1648,14 +1634,13 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag}. + * The first element of the array is Array of {@link protos.google.cloud.datacatalog.v1beta1.PolicyTag|PolicyTag}. * 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 `listPolicyTagsAsync()` * 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. */ listPolicyTags( @@ -1748,13 +1733,12 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datacatalog.v1beta1.PolicyTag|PolicyTag} 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 `listPolicyTagsAsync()` * 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. */ listPolicyTagsStream( @@ -1796,12 +1780,11 @@ export class PolicyTagManagerClient { * @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.datacatalog.v1beta1.PolicyTag | PolicyTag}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datacatalog.v1beta1.PolicyTag|PolicyTag}. 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/policy_tag_manager.list_policy_tags.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManager_ListPolicyTags_async diff --git a/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_serialization_client.ts b/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_serialization_client.ts index 4eae5ad80eb..6d4c6c74140 100644 --- a/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_serialization_client.ts +++ b/packages/google-cloud-datacatalog/src/v1beta1/policy_tag_manager_serialization_client.ts @@ -357,9 +357,8 @@ export class PolicyTagManagerSerializationClient { * @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.datacatalog.v1beta1.ImportTaxonomiesResponse | ImportTaxonomiesResponse}. - * 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.datacatalog.v1beta1.ImportTaxonomiesResponse|ImportTaxonomiesResponse}. + * 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/policy_tag_manager_serialization.import_taxonomies.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManagerSerialization_ImportTaxonomies_async @@ -462,9 +461,8 @@ export class PolicyTagManagerSerializationClient { * @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.datacatalog.v1beta1.ExportTaxonomiesResponse | ExportTaxonomiesResponse}. - * 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.datacatalog.v1beta1.ExportTaxonomiesResponse|ExportTaxonomiesResponse}. + * 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/policy_tag_manager_serialization.export_taxonomies.js * region_tag:datacatalog_v1beta1_generated_PolicyTagManagerSerialization_ExportTaxonomies_async diff --git a/packages/google-cloud-dataform/README.md b/packages/google-cloud-dataform/README.md index 871cc4a77f0..345ebeaab62 100644 --- a/packages/google-cloud-dataform/README.md +++ b/packages/google-cloud-dataform/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Dataform API: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Dataform API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-dataform) [![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/dataform.svg)](https://www.npmjs.org/package/@google-cloud/dataform) @@ -58,84 +58,83 @@ npm install @google-cloud/dataform ## 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-dataform/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Dataform.cancel_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.cancel_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.cancel_workflow_invocation.js,samples/README.md) | -| Dataform.commit_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js,samples/README.md) | -| Dataform.create_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_compilation_result.js,samples/README.md) | -| Dataform.create_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_repository.js,samples/README.md) | -| Dataform.create_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_workflow_invocation.js,samples/README.md) | -| Dataform.create_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_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-cloud-dataform/samples/generated/v1alpha2/dataform.create_workspace.js,samples/README.md) | -| Dataform.delete_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.delete_repository.js,samples/README.md) | -| Dataform.delete_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.delete_workflow_invocation.js,samples/README.md) | -| Dataform.delete_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_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-cloud-dataform/samples/generated/v1alpha2/dataform.delete_workspace.js,samples/README.md) | -| Dataform.fetch_file_diff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_file_diff.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_file_diff.js,samples/README.md) | -| Dataform.fetch_file_git_statuses | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_file_git_statuses.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_file_git_statuses.js,samples/README.md) | -| Dataform.fetch_git_ahead_behind | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_git_ahead_behind.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_git_ahead_behind.js,samples/README.md) | -| Dataform.fetch_remote_branches | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_remote_branches.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_remote_branches.js,samples/README.md) | -| Dataform.get_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_compilation_result.js,samples/README.md) | -| Dataform.get_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_repository.js,samples/README.md) | -| Dataform.get_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_workflow_invocation.js,samples/README.md) | -| Dataform.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.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-cloud-dataform/samples/generated/v1alpha2/dataform.get_workspace.js,samples/README.md) | -| Dataform.install_npm_packages | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.install_npm_packages.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.install_npm_packages.js,samples/README.md) | -| Dataform.list_compilation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_compilation_results.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_compilation_results.js,samples/README.md) | -| Dataform.list_repositories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_repositories.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_repositories.js,samples/README.md) | -| Dataform.list_workflow_invocations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_workflow_invocations.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_workflow_invocations.js,samples/README.md) | -| Dataform.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.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-cloud-dataform/samples/generated/v1alpha2/dataform.list_workspaces.js,samples/README.md) | -| Dataform.make_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.make_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.make_directory.js,samples/README.md) | -| Dataform.move_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.move_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.move_directory.js,samples/README.md) | -| Dataform.move_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.move_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.move_file.js,samples/README.md) | -| Dataform.pull_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.pull_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.pull_git_commits.js,samples/README.md) | -| Dataform.push_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.push_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.push_git_commits.js,samples/README.md) | -| Dataform.query_compilation_result_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_compilation_result_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_compilation_result_actions.js,samples/README.md) | -| Dataform.query_directory_contents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_directory_contents.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_directory_contents.js,samples/README.md) | -| Dataform.query_workflow_invocation_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_workflow_invocation_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_workflow_invocation_actions.js,samples/README.md) | -| Dataform.read_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.read_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.read_file.js,samples/README.md) | -| Dataform.remove_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.remove_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.remove_directory.js,samples/README.md) | -| Dataform.remove_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.remove_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.remove_file.js,samples/README.md) | -| Dataform.reset_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js,samples/README.md) | -| Dataform.update_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.update_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.update_repository.js,samples/README.md) | -| Dataform.write_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.write_file.js,samples/README.md) | -| Dataform.cancel_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.cancel_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.cancel_workflow_invocation.js,samples/README.md) | -| Dataform.commit_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js,samples/README.md) | -| Dataform.create_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_compilation_result.js,samples/README.md) | -| Dataform.create_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_repository.js,samples/README.md) | -| Dataform.create_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_workflow_invocation.js,samples/README.md) | -| Dataform.create_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_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-cloud-dataform/samples/generated/v1beta1/dataform.create_workspace.js,samples/README.md) | -| Dataform.delete_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.delete_repository.js,samples/README.md) | -| Dataform.delete_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.delete_workflow_invocation.js,samples/README.md) | -| Dataform.delete_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_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-cloud-dataform/samples/generated/v1beta1/dataform.delete_workspace.js,samples/README.md) | -| Dataform.fetch_file_diff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_diff.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_file_diff.js,samples/README.md) | -| Dataform.fetch_file_git_statuses | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_git_statuses.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_file_git_statuses.js,samples/README.md) | -| Dataform.fetch_git_ahead_behind | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_git_ahead_behind.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_git_ahead_behind.js,samples/README.md) | -| Dataform.fetch_remote_branches | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_remote_branches.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_remote_branches.js,samples/README.md) | -| Dataform.get_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_compilation_result.js,samples/README.md) | -| Dataform.get_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_repository.js,samples/README.md) | -| Dataform.get_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_workflow_invocation.js,samples/README.md) | -| Dataform.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.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-cloud-dataform/samples/generated/v1beta1/dataform.get_workspace.js,samples/README.md) | -| Dataform.install_npm_packages | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.install_npm_packages.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.install_npm_packages.js,samples/README.md) | -| Dataform.list_compilation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_compilation_results.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_compilation_results.js,samples/README.md) | -| Dataform.list_repositories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_repositories.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_repositories.js,samples/README.md) | -| Dataform.list_workflow_invocations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_workflow_invocations.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_workflow_invocations.js,samples/README.md) | -| Dataform.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.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-cloud-dataform/samples/generated/v1beta1/dataform.list_workspaces.js,samples/README.md) | -| Dataform.make_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.make_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.make_directory.js,samples/README.md) | -| Dataform.move_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.move_directory.js,samples/README.md) | -| Dataform.move_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.move_file.js,samples/README.md) | -| Dataform.pull_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.pull_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.pull_git_commits.js,samples/README.md) | -| Dataform.push_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.push_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.push_git_commits.js,samples/README.md) | -| Dataform.query_compilation_result_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_compilation_result_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_compilation_result_actions.js,samples/README.md) | -| Dataform.query_directory_contents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_directory_contents.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_directory_contents.js,samples/README.md) | -| Dataform.query_workflow_invocation_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_workflow_invocation_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_workflow_invocation_actions.js,samples/README.md) | -| Dataform.read_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.read_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.read_file.js,samples/README.md) | -| Dataform.remove_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.remove_directory.js,samples/README.md) | -| Dataform.remove_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.remove_file.js,samples/README.md) | -| Dataform.reset_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js,samples/README.md) | -| Dataform.update_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.update_repository.js,samples/README.md) | -| Dataform.write_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.write_file.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/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-dataform/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/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-dataform/samples/test/quickstart.js,samples/README.md) | +| Dataform.cancel_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.cancel_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.cancel_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.commit_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_compilation_result.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.create_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.create_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-cloud-dataform/samples/generated/v1alpha2/dataform.create_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.delete_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.delete_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.delete_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-cloud-dataform/samples/generated/v1alpha2/dataform.delete_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_file_diff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_file_diff.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_file_diff.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_file_git_statuses | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_file_git_statuses.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_file_git_statuses.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_git_ahead_behind | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_git_ahead_behind.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_git_ahead_behind.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_remote_branches | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.fetch_remote_branches.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.fetch_remote_branches.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_compilation_result.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.get_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.get_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.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-cloud-dataform/samples/generated/v1alpha2/dataform.get_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.install_npm_packages | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.install_npm_packages.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.install_npm_packages.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_compilation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_compilation_results.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_compilation_results.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_repositories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_repositories.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_repositories.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_workflow_invocations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.list_workflow_invocations.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.list_workflow_invocations.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.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-cloud-dataform/samples/generated/v1alpha2/dataform.list_workspaces.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.make_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.make_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.make_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.move_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.move_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.move_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.move_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.move_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.move_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.pull_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.pull_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.pull_git_commits.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.push_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.push_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.push_git_commits.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_compilation_result_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_compilation_result_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_compilation_result_actions.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_directory_contents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_directory_contents.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_directory_contents.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_workflow_invocation_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.query_workflow_invocation_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.query_workflow_invocation_actions.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.read_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.read_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.read_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.remove_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.remove_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.remove_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.remove_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.remove_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.remove_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.reset_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.update_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.update_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.update_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.write_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1alpha2/dataform.write_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.cancel_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.cancel_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.cancel_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.commit_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_compilation_result.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.create_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.create_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_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-cloud-dataform/samples/generated/v1beta1/dataform.create_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.delete_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.delete_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.delete_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_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-cloud-dataform/samples/generated/v1beta1/dataform.delete_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_file_diff | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_diff.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_file_diff.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_file_git_statuses | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_git_statuses.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_file_git_statuses.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_git_ahead_behind | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_git_ahead_behind.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_git_ahead_behind.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.fetch_remote_branches | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_remote_branches.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.fetch_remote_branches.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_compilation_result | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_compilation_result.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_compilation_result.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_workflow_invocation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_workflow_invocation.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.get_workflow_invocation.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.get_workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.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-cloud-dataform/samples/generated/v1beta1/dataform.get_workspace.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.install_npm_packages | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.install_npm_packages.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.install_npm_packages.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_compilation_results | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_compilation_results.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_compilation_results.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_repositories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_repositories.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_repositories.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_workflow_invocations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_workflow_invocations.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.list_workflow_invocations.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.list_workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.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-cloud-dataform/samples/generated/v1beta1/dataform.list_workspaces.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.make_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.make_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.make_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.move_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.move_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.move_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.move_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.pull_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.pull_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.pull_git_commits.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.push_git_commits | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.push_git_commits.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.push_git_commits.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_compilation_result_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_compilation_result_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_compilation_result_actions.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_directory_contents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_directory_contents.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_directory_contents.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.query_workflow_invocation_actions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_workflow_invocation_actions.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.query_workflow_invocation_actions.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.read_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.read_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.read_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.remove_directory | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_directory.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.remove_directory.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.remove_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.remove_file.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.reset_workspace_changes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.update_repository | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_repository.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.update_repository.js,packages/google-cloud-dataform/samples/README.md) | +| Dataform.write_file | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js) | [![Open in Cloud Shell][shell_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-dataform/samples/generated/v1beta1/dataform.write_file.js,packages/google-cloud-dataform/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/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-dataform/samples/quickstart.js,packages/google-cloud-dataform/samples/README.md) | diff --git a/packages/google-cloud-dataform/package.json b/packages/google-cloud-dataform/package.json index f16d44e9579..2865c23e966 100644 --- a/packages/google-cloud-dataform/package.json +++ b/packages/google-cloud-dataform/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": "^10.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-dataform" } diff --git a/packages/google-cloud-dataform/samples/README.md b/packages/google-cloud-dataform/samples/README.md index e1b05f2171d..a1b05e0387e 100644 --- a/packages/google-cloud-dataform/samples/README.md +++ b/packages/google-cloud-dataform/samples/README.md @@ -85,7 +85,6 @@ * [Dataform.update_repository](#dataform.update_repository) * [Dataform.write_file](#dataform.write_file) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -1338,23 +1337,6 @@ __Usage:__ `node packages/google-cloud-dataform/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/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-dataform/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-dataform/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js index d56a4bc7ea2..71d6ed4f530 100644 --- a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js +++ b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.commit_workspace_changes.js @@ -44,7 +44,7 @@ function main(name, author) { * Optional. Full file paths to commit including filename, rooted at workspace root. If * left empty, all files will be committed. */ - // const paths = 'abc123' + // const paths = ['abc','def'] // Imports the Dataform library const {DataformClient} = require('@google-cloud/dataform').v1alpha2; diff --git a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js index 4179d277bbf..193812d78be 100644 --- a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js +++ b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.reset_workspace_changes.js @@ -36,7 +36,7 @@ function main(name) { * Optional. Full file paths to reset back to their committed state including filename, * rooted at workspace root. If left empty, all files will be reset. */ - // const paths = 'abc123' + // const paths = ['abc','def'] /** * Optional. If set to true, untracked files will be deleted. */ diff --git a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js index d8305c71258..2fa37902314 100644 --- a/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js +++ b/packages/google-cloud-dataform/samples/generated/v1alpha2/dataform.write_file.js @@ -39,7 +39,7 @@ function main(workspace, path, contents) { /** * Required. The file's contents. */ - // const contents = 'Buffer.from('string')' + // const contents = Buffer.from('string') // Imports the Dataform library const {DataformClient} = require('@google-cloud/dataform').v1alpha2; diff --git a/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata.google.cloud.dataform.v1alpha2.json b/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata.google.cloud.dataform.v1alpha2.json index cb28b997e36..39ec7d6ac2e 100644 --- a/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata.google.cloud.dataform.v1alpha2.json +++ b/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata.google.cloud.dataform.v1alpha2.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-dataform", - "version": "0.4.1", + "version": "0.4.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata_google.cloud.dataform.v1alpha2.json b/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata_google.cloud.dataform.v1alpha2.json new file mode 100644 index 00000000000..39ec7d6ac2e --- /dev/null +++ b/packages/google-cloud-dataform/samples/generated/v1alpha2/snippet_metadata_google.cloud.dataform.v1alpha2.json @@ -0,0 +1,1647 @@ +{ + "clientLibrary": { + "name": "nodejs-dataform", + "version": "0.4.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.dataform.v1alpha2", + "version": "v1alpha2" + } + ] + }, + "snippets": [ + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ListRepositories_async", + "title": "Dataform listRepositories Sample", + "origin": "API_DEFINITION", + "description": " Lists Repositories in a given project and location.", + "canonical": true, + "file": "dataform.list_repositories.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListRepositories", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListRepositories", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.ListRepositoriesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ListRepositories", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListRepositories", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_GetRepository_async", + "title": "Dataform getRepository Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single Repository.", + "canonical": true, + "file": "dataform.get_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetRepository", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "GetRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CreateRepository_async", + "title": "Dataform createRepository Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Repository in a given project and location.", + "canonical": true, + "file": "dataform.create_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateRepository", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "repository", + "type": ".google.cloud.dataform.v1alpha2.Repository" + }, + { + "name": "repository_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CreateRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_UpdateRepository_async", + "title": "Dataform updateRepository Sample", + "origin": "API_DEFINITION", + "description": " Updates a single Repository.", + "canonical": true, + "file": "dataform.update_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.UpdateRepository", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "repository", + "type": ".google.cloud.dataform.v1alpha2.Repository" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "UpdateRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.UpdateRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_DeleteRepository_async", + "title": "Dataform deleteRepository Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Repository.", + "canonical": true, + "file": "dataform.delete_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteRepository", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "DeleteRepository", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_FetchRemoteBranches_async", + "title": "Dataform fetchRemoteBranches Sample", + "origin": "API_DEFINITION", + "description": " Fetches a Repository's remote branches.", + "canonical": true, + "file": "dataform.fetch_remote_branches.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchRemoteBranches", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchRemoteBranches", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.FetchRemoteBranchesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "FetchRemoteBranches", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchRemoteBranches", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ListWorkspaces_async", + "title": "Dataform listWorkspaces Sample", + "origin": "API_DEFINITION", + "description": " Lists Workspaces in a given Repository.", + "canonical": true, + "file": "dataform.list_workspaces.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkspaces", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListWorkspaces", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.ListWorkspacesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ListWorkspaces", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListWorkspaces", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_GetWorkspace_async", + "title": "Dataform getWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single Workspace.", + "canonical": true, + "file": "dataform.get_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.Workspace", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "GetWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CreateWorkspace_async", + "title": "Dataform createWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Workspace in a given Repository.", + "canonical": true, + "file": "dataform.create_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateWorkspace", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workspace", + "type": ".google.cloud.dataform.v1alpha2.Workspace" + }, + { + "name": "workspace_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.Workspace", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CreateWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_DeleteWorkspace_async", + "title": "Dataform deleteWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Workspace.", + "canonical": true, + "file": "dataform.delete_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "DeleteWorkspace", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_InstallNpmPackages_async", + "title": "Dataform installNpmPackages Sample", + "origin": "API_DEFINITION", + "description": " Installs dependency NPM packages (inside a Workspace).", + "canonical": true, + "file": "dataform.install_npm_packages.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InstallNpmPackages", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.InstallNpmPackages", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.InstallNpmPackagesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "InstallNpmPackages", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.InstallNpmPackages", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_PullGitCommits_async", + "title": "Dataform pullGitCommits Sample", + "origin": "API_DEFINITION", + "description": " Pulls Git commits from the Repository's remote into a Workspace.", + "canonical": true, + "file": "dataform.pull_git_commits.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PullGitCommits", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.PullGitCommits", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + }, + { + "name": "author", + "type": ".google.cloud.dataform.v1alpha2.CommitAuthor" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "PullGitCommits", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.PullGitCommits", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_PushGitCommits_async", + "title": "Dataform pushGitCommits Sample", + "origin": "API_DEFINITION", + "description": " Pushes Git commits from a Workspace to the Repository's remote.", + "canonical": true, + "file": "dataform.push_git_commits.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PushGitCommits", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.PushGitCommits", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "PushGitCommits", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.PushGitCommits", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_FetchFileGitStatuses_async", + "title": "Dataform fetchFileGitStatuses Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git statuses for the files in a Workspace.", + "canonical": true, + "file": "dataform.fetch_file_git_statuses.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchFileGitStatuses", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchFileGitStatuses", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.FetchFileGitStatusesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "FetchFileGitStatuses", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchFileGitStatuses", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_FetchGitAheadBehind_async", + "title": "Dataform fetchGitAheadBehind Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git ahead/behind against a remote branch.", + "canonical": true, + "file": "dataform.fetch_git_ahead_behind.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchGitAheadBehind", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchGitAheadBehind", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.FetchGitAheadBehindResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "FetchGitAheadBehind", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchGitAheadBehind", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CommitWorkspaceChanges_async", + "title": "Dataform commitWorkspaceChanges Sample", + "origin": "API_DEFINITION", + "description": " Applies a Git commit for uncommitted files in a Workspace.", + "canonical": true, + "file": "dataform.commit_workspace_changes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CommitWorkspaceChanges", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CommitWorkspaceChanges", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "author", + "type": ".google.cloud.dataform.v1alpha2.CommitAuthor" + }, + { + "name": "commit_message", + "type": "TYPE_STRING" + }, + { + "name": "paths", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CommitWorkspaceChanges", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CommitWorkspaceChanges", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ResetWorkspaceChanges_async", + "title": "Dataform resetWorkspaceChanges Sample", + "origin": "API_DEFINITION", + "description": " Performs a Git reset for uncommitted files in a Workspace.", + "canonical": true, + "file": "dataform.reset_workspace_changes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResetWorkspaceChanges", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ResetWorkspaceChanges", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "paths", + "type": "TYPE_STRING[]" + }, + { + "name": "clean", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ResetWorkspaceChanges", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ResetWorkspaceChanges", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_FetchFileDiff_async", + "title": "Dataform fetchFileDiff Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git diff for an uncommitted file in a Workspace.", + "canonical": true, + "file": "dataform.fetch_file_diff.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchFileDiff", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchFileDiff", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.FetchFileDiffResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "FetchFileDiff", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.FetchFileDiff", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_QueryDirectoryContents_async", + "title": "Dataform queryDirectoryContents Sample", + "origin": "API_DEFINITION", + "description": " Returns the contents of a given Workspace directory.", + "canonical": true, + "file": "dataform.query_directory_contents.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryDirectoryContents", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryDirectoryContents", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.QueryDirectoryContentsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "QueryDirectoryContents", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryDirectoryContents", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_MakeDirectory_async", + "title": "Dataform makeDirectory Sample", + "origin": "API_DEFINITION", + "description": " Creates a directory inside a Workspace.", + "canonical": true, + "file": "dataform.make_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MakeDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MakeDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.MakeDirectoryResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "MakeDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MakeDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_RemoveDirectory_async", + "title": "Dataform removeDirectory Sample", + "origin": "API_DEFINITION", + "description": " Deletes a directory (inside a Workspace) and all of its contents.", + "canonical": true, + "file": "dataform.remove_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.RemoveDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "RemoveDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.RemoveDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_MoveDirectory_async", + "title": "Dataform moveDirectory Sample", + "origin": "API_DEFINITION", + "description": " Moves a directory (inside a Workspace), and all of its contents, to a new location.", + "canonical": true, + "file": "dataform.move_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MoveDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "new_path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.MoveDirectoryResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "MoveDirectory", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MoveDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ReadFile_async", + "title": "Dataform readFile Sample", + "origin": "API_DEFINITION", + "description": " Returns the contents of a file (inside a Workspace).", + "canonical": true, + "file": "dataform.read_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ReadFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.ReadFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ReadFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ReadFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_RemoveFile_async", + "title": "Dataform removeFile Sample", + "origin": "API_DEFINITION", + "description": " Deletes a file (inside a Workspace).", + "canonical": true, + "file": "dataform.remove_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.RemoveFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "RemoveFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.RemoveFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_MoveFile_async", + "title": "Dataform moveFile Sample", + "origin": "API_DEFINITION", + "description": " Moves a file (inside a Workspace) to a new location.", + "canonical": true, + "file": "dataform.move_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MoveFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "new_path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.MoveFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "MoveFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.MoveFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_WriteFile_async", + "title": "Dataform writeFile Sample", + "origin": "API_DEFINITION", + "description": " Writes to a file (inside a Workspace).", + "canonical": true, + "file": "dataform.write_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.WriteFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "contents", + "type": "TYPE_BYTES" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.WriteFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "WriteFile", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.WriteFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ListCompilationResults_async", + "title": "Dataform listCompilationResults Sample", + "origin": "API_DEFINITION", + "description": " Lists CompilationResults in a given Repository.", + "canonical": true, + "file": "dataform.list_compilation_results.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCompilationResults", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListCompilationResults", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.ListCompilationResultsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ListCompilationResults", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListCompilationResults", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_GetCompilationResult_async", + "title": "Dataform getCompilationResult Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single CompilationResult.", + "canonical": true, + "file": "dataform.get_compilation_result.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCompilationResult", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetCompilationResult", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.CompilationResult", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "GetCompilationResult", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetCompilationResult", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CreateCompilationResult_async", + "title": "Dataform createCompilationResult Sample", + "origin": "API_DEFINITION", + "description": " Creates a new CompilationResult in a given project and location.", + "canonical": true, + "file": "dataform.create_compilation_result.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCompilationResult", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateCompilationResult", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "compilation_result", + "type": ".google.cloud.dataform.v1alpha2.CompilationResult" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.CompilationResult", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CreateCompilationResult", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateCompilationResult", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_QueryCompilationResultActions_async", + "title": "Dataform queryCompilationResultActions Sample", + "origin": "API_DEFINITION", + "description": " Returns CompilationResultActions in a given CompilationResult.", + "canonical": true, + "file": "dataform.query_compilation_result_actions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryCompilationResultActions", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryCompilationResultActions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.QueryCompilationResultActionsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "QueryCompilationResultActions", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryCompilationResultActions", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_ListWorkflowInvocations_async", + "title": "Dataform listWorkflowInvocations Sample", + "origin": "API_DEFINITION", + "description": " Lists WorkflowInvocations in a given Repository.", + "canonical": true, + "file": "dataform.list_workflow_invocations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkflowInvocations", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListWorkflowInvocations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.ListWorkflowInvocationsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "ListWorkflowInvocations", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.ListWorkflowInvocations", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_GetWorkflowInvocation_async", + "title": "Dataform getWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single WorkflowInvocation.", + "canonical": true, + "file": "dataform.get_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.WorkflowInvocation", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "GetWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.GetWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CreateWorkflowInvocation_async", + "title": "Dataform createWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Creates a new WorkflowInvocation in a given Repository.", + "canonical": true, + "file": "dataform.create_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workflow_invocation", + "type": ".google.cloud.dataform.v1alpha2.WorkflowInvocation" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.WorkflowInvocation", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CreateWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CreateWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_DeleteWorkflowInvocation_async", + "title": "Dataform deleteWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single WorkflowInvocation.", + "canonical": true, + "file": "dataform.delete_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "DeleteWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.DeleteWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_CancelWorkflowInvocation_async", + "title": "Dataform cancelWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Requests cancellation of a running WorkflowInvocation.", + "canonical": true, + "file": "dataform.cancel_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CancelWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "CancelWorkflowInvocation", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.CancelWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1alpha2_generated_Dataform_QueryWorkflowInvocationActions_async", + "title": "Dataform queryWorkflowInvocationActions Sample", + "origin": "API_DEFINITION", + "description": " Returns WorkflowInvocationActions in a given WorkflowInvocation.", + "canonical": true, + "file": "dataform.query_workflow_invocation_actions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryWorkflowInvocationActions", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryWorkflowInvocationActions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1alpha2.QueryWorkflowInvocationActionsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1alpha2.DataformClient" + }, + "method": { + "shortName": "QueryWorkflowInvocationActions", + "fullName": "google.cloud.dataform.v1alpha2.Dataform.QueryWorkflowInvocationActions", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1alpha2.Dataform" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js index 2f4f876ccc5..4e9fa746068 100644 --- a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js +++ b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js @@ -44,7 +44,7 @@ function main(name, author) { * Optional. Full file paths to commit including filename, rooted at workspace root. If * left empty, all files will be committed. */ - // const paths = 'abc123' + // const paths = ['abc','def'] // Imports the Dataform library const {DataformClient} = require('@google-cloud/dataform').v1beta1; diff --git a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js index b5c255e3919..a6b4c158789 100644 --- a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js +++ b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js @@ -36,7 +36,7 @@ function main(name) { * Optional. Full file paths to reset back to their committed state including filename, * rooted at workspace root. If left empty, all files will be reset. */ - // const paths = 'abc123' + // const paths = ['abc','def'] /** * Optional. If set to true, untracked files will be deleted. */ diff --git a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js index 62ed1b6e99d..0b4fc2d2050 100644 --- a/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js +++ b/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js @@ -39,7 +39,7 @@ function main(workspace, path, contents) { /** * Required. The file's contents. */ - // const contents = 'Buffer.from('string')' + // const contents = Buffer.from('string') // Imports the Dataform library const {DataformClient} = require('@google-cloud/dataform').v1beta1; diff --git a/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata.google.cloud.dataform.v1beta1.json b/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata.google.cloud.dataform.v1beta1.json index e48562ca65d..785f2a3b5af 100644 --- a/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata.google.cloud.dataform.v1beta1.json +++ b/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata.google.cloud.dataform.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-dataform", - "version": "0.4.1", + "version": "0.4.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata_google.cloud.dataform.v1beta1.json b/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata_google.cloud.dataform.v1beta1.json new file mode 100644 index 00000000000..785f2a3b5af --- /dev/null +++ b/packages/google-cloud-dataform/samples/generated/v1beta1/snippet_metadata_google.cloud.dataform.v1beta1.json @@ -0,0 +1,1647 @@ +{ + "clientLibrary": { + "name": "nodejs-dataform", + "version": "0.4.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.dataform.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "dataform_v1beta1_generated_Dataform_ListRepositories_async", + "title": "Dataform listRepositories Sample", + "origin": "API_DEFINITION", + "description": " Lists Repositories in a given project and location.", + "canonical": true, + "file": "dataform.list_repositories.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListRepositories", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListRepositories", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.ListRepositoriesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ListRepositories", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListRepositories", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_GetRepository_async", + "title": "Dataform getRepository Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single Repository.", + "canonical": true, + "file": "dataform.get_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetRepository", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "GetRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CreateRepository_async", + "title": "Dataform createRepository Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Repository in a given project and location.", + "canonical": true, + "file": "dataform.create_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateRepository", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "repository", + "type": ".google.cloud.dataform.v1beta1.Repository" + }, + { + "name": "repository_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CreateRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_UpdateRepository_async", + "title": "Dataform updateRepository Sample", + "origin": "API_DEFINITION", + "description": " Updates a single Repository.", + "canonical": true, + "file": "dataform.update_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.UpdateRepository", + "async": true, + "parameters": [ + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + }, + { + "name": "repository", + "type": ".google.cloud.dataform.v1beta1.Repository" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.Repository", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "UpdateRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.UpdateRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_DeleteRepository_async", + "title": "Dataform deleteRepository Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Repository.", + "canonical": true, + "file": "dataform.delete_repository.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteRepository", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "force", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "DeleteRepository", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteRepository", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_FetchRemoteBranches_async", + "title": "Dataform fetchRemoteBranches Sample", + "origin": "API_DEFINITION", + "description": " Fetches a Repository's remote branches.", + "canonical": true, + "file": "dataform.fetch_remote_branches.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchRemoteBranches", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchRemoteBranches", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.FetchRemoteBranchesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "FetchRemoteBranches", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchRemoteBranches", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_ListWorkspaces_async", + "title": "Dataform listWorkspaces Sample", + "origin": "API_DEFINITION", + "description": " Lists Workspaces in a given Repository.", + "canonical": true, + "file": "dataform.list_workspaces.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 79, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkspaces", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListWorkspaces", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "order_by", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.ListWorkspacesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ListWorkspaces", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListWorkspaces", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_GetWorkspace_async", + "title": "Dataform getWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single Workspace.", + "canonical": true, + "file": "dataform.get_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.Workspace", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "GetWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CreateWorkspace_async", + "title": "Dataform createWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Workspace in a given Repository.", + "canonical": true, + "file": "dataform.create_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateWorkspace", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workspace", + "type": ".google.cloud.dataform.v1beta1.Workspace" + }, + { + "name": "workspace_id", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.Workspace", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CreateWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_DeleteWorkspace_async", + "title": "Dataform deleteWorkspace Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Workspace.", + "canonical": true, + "file": "dataform.delete_workspace.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteWorkspace", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "DeleteWorkspace", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteWorkspace", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_InstallNpmPackages_async", + "title": "Dataform installNpmPackages Sample", + "origin": "API_DEFINITION", + "description": " Installs dependency NPM packages (inside a Workspace).", + "canonical": true, + "file": "dataform.install_npm_packages.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "InstallNpmPackages", + "fullName": "google.cloud.dataform.v1beta1.Dataform.InstallNpmPackages", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.InstallNpmPackagesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "InstallNpmPackages", + "fullName": "google.cloud.dataform.v1beta1.Dataform.InstallNpmPackages", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_PullGitCommits_async", + "title": "Dataform pullGitCommits Sample", + "origin": "API_DEFINITION", + "description": " Pulls Git commits from the Repository's remote into a Workspace.", + "canonical": true, + "file": "dataform.pull_git_commits.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PullGitCommits", + "fullName": "google.cloud.dataform.v1beta1.Dataform.PullGitCommits", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + }, + { + "name": "author", + "type": ".google.cloud.dataform.v1beta1.CommitAuthor" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "PullGitCommits", + "fullName": "google.cloud.dataform.v1beta1.Dataform.PullGitCommits", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_PushGitCommits_async", + "title": "Dataform pushGitCommits Sample", + "origin": "API_DEFINITION", + "description": " Pushes Git commits from a Workspace to the Repository's remote.", + "canonical": true, + "file": "dataform.push_git_commits.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PushGitCommits", + "fullName": "google.cloud.dataform.v1beta1.Dataform.PushGitCommits", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "PushGitCommits", + "fullName": "google.cloud.dataform.v1beta1.Dataform.PushGitCommits", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_FetchFileGitStatuses_async", + "title": "Dataform fetchFileGitStatuses Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git statuses for the files in a Workspace.", + "canonical": true, + "file": "dataform.fetch_file_git_statuses.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchFileGitStatuses", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchFileGitStatuses", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.FetchFileGitStatusesResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "FetchFileGitStatuses", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchFileGitStatuses", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_FetchGitAheadBehind_async", + "title": "Dataform fetchGitAheadBehind Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git ahead/behind against a remote branch.", + "canonical": true, + "file": "dataform.fetch_git_ahead_behind.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchGitAheadBehind", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchGitAheadBehind", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "remote_branch", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.FetchGitAheadBehindResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "FetchGitAheadBehind", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchGitAheadBehind", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CommitWorkspaceChanges_async", + "title": "Dataform commitWorkspaceChanges Sample", + "origin": "API_DEFINITION", + "description": " Applies a Git commit for uncommitted files in a Workspace.", + "canonical": true, + "file": "dataform.commit_workspace_changes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 67, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CommitWorkspaceChanges", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CommitWorkspaceChanges", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "author", + "type": ".google.cloud.dataform.v1beta1.CommitAuthor" + }, + { + "name": "commit_message", + "type": "TYPE_STRING" + }, + { + "name": "paths", + "type": "TYPE_STRING[]" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CommitWorkspaceChanges", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CommitWorkspaceChanges", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_ResetWorkspaceChanges_async", + "title": "Dataform resetWorkspaceChanges Sample", + "origin": "API_DEFINITION", + "description": " Performs a Git reset for uncommitted files in a Workspace.", + "canonical": true, + "file": "dataform.reset_workspace_changes.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 62, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResetWorkspaceChanges", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ResetWorkspaceChanges", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "paths", + "type": "TYPE_STRING[]" + }, + { + "name": "clean", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ResetWorkspaceChanges", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ResetWorkspaceChanges", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_FetchFileDiff_async", + "title": "Dataform fetchFileDiff Sample", + "origin": "API_DEFINITION", + "description": " Fetches Git diff for an uncommitted file in a Workspace.", + "canonical": true, + "file": "dataform.fetch_file_diff.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "FetchFileDiff", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchFileDiff", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.FetchFileDiffResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "FetchFileDiff", + "fullName": "google.cloud.dataform.v1beta1.Dataform.FetchFileDiff", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_QueryDirectoryContents_async", + "title": "Dataform queryDirectoryContents Sample", + "origin": "API_DEFINITION", + "description": " Returns the contents of a given Workspace directory.", + "canonical": true, + "file": "dataform.query_directory_contents.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryDirectoryContents", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryDirectoryContents", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "QueryDirectoryContents", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryDirectoryContents", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_MakeDirectory_async", + "title": "Dataform makeDirectory Sample", + "origin": "API_DEFINITION", + "description": " Creates a directory inside a Workspace.", + "canonical": true, + "file": "dataform.make_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MakeDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MakeDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.MakeDirectoryResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "MakeDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MakeDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_RemoveDirectory_async", + "title": "Dataform removeDirectory Sample", + "origin": "API_DEFINITION", + "description": " Deletes a directory (inside a Workspace) and all of its contents.", + "canonical": true, + "file": "dataform.remove_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.RemoveDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "RemoveDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.RemoveDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_MoveDirectory_async", + "title": "Dataform moveDirectory Sample", + "origin": "API_DEFINITION", + "description": " Moves a directory (inside a Workspace), and all of its contents, to a new location.", + "canonical": true, + "file": "dataform.move_directory.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MoveDirectory", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "new_path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.MoveDirectoryResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "MoveDirectory", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MoveDirectory", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_ReadFile_async", + "title": "Dataform readFile Sample", + "origin": "API_DEFINITION", + "description": " Returns the contents of a file (inside a Workspace).", + "canonical": true, + "file": "dataform.read_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ReadFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ReadFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.ReadFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ReadFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ReadFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_RemoveFile_async", + "title": "Dataform removeFile Sample", + "origin": "API_DEFINITION", + "description": " Deletes a file (inside a Workspace).", + "canonical": true, + "file": "dataform.remove_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.RemoveFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "RemoveFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.RemoveFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_MoveFile_async", + "title": "Dataform moveFile Sample", + "origin": "API_DEFINITION", + "description": " Moves a file (inside a Workspace) to a new location.", + "canonical": true, + "file": "dataform.move_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "MoveFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MoveFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "new_path", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.MoveFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "MoveFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.MoveFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_WriteFile_async", + "title": "Dataform writeFile Sample", + "origin": "API_DEFINITION", + "description": " Writes to a file (inside a Workspace).", + "canonical": true, + "file": "dataform.write_file.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "WriteFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.WriteFile", + "async": true, + "parameters": [ + { + "name": "workspace", + "type": "TYPE_STRING" + }, + { + "name": "path", + "type": "TYPE_STRING" + }, + { + "name": "contents", + "type": "TYPE_BYTES" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.WriteFileResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "WriteFile", + "fullName": "google.cloud.dataform.v1beta1.Dataform.WriteFile", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_ListCompilationResults_async", + "title": "Dataform listCompilationResults Sample", + "origin": "API_DEFINITION", + "description": " Lists CompilationResults in a given Repository.", + "canonical": true, + "file": "dataform.list_compilation_results.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListCompilationResults", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListCompilationResults", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.ListCompilationResultsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ListCompilationResults", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListCompilationResults", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_GetCompilationResult_async", + "title": "Dataform getCompilationResult Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single CompilationResult.", + "canonical": true, + "file": "dataform.get_compilation_result.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetCompilationResult", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetCompilationResult", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.CompilationResult", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "GetCompilationResult", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetCompilationResult", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CreateCompilationResult_async", + "title": "Dataform createCompilationResult Sample", + "origin": "API_DEFINITION", + "description": " Creates a new CompilationResult in a given project and location.", + "canonical": true, + "file": "dataform.create_compilation_result.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateCompilationResult", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateCompilationResult", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "compilation_result", + "type": ".google.cloud.dataform.v1beta1.CompilationResult" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.CompilationResult", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CreateCompilationResult", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateCompilationResult", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_QueryCompilationResultActions_async", + "title": "Dataform queryCompilationResultActions Sample", + "origin": "API_DEFINITION", + "description": " Returns CompilationResultActions in a given CompilationResult.", + "canonical": true, + "file": "dataform.query_compilation_result_actions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 74, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryCompilationResultActions", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryCompilationResultActions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.QueryCompilationResultActionsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "QueryCompilationResultActions", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryCompilationResultActions", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_ListWorkflowInvocations_async", + "title": "Dataform listWorkflowInvocations Sample", + "origin": "API_DEFINITION", + "description": " Lists WorkflowInvocations in a given Repository.", + "canonical": true, + "file": "dataform.list_workflow_invocations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListWorkflowInvocations", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListWorkflowInvocations", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.ListWorkflowInvocationsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "ListWorkflowInvocations", + "fullName": "google.cloud.dataform.v1beta1.Dataform.ListWorkflowInvocations", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_GetWorkflowInvocation_async", + "title": "Dataform getWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Fetches a single WorkflowInvocation.", + "canonical": true, + "file": "dataform.get_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.WorkflowInvocation", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "GetWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.GetWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CreateWorkflowInvocation_async", + "title": "Dataform createWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Creates a new WorkflowInvocation in a given Repository.", + "canonical": true, + "file": "dataform.create_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "workflow_invocation", + "type": ".google.cloud.dataform.v1beta1.WorkflowInvocation" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.WorkflowInvocation", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CreateWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CreateWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_DeleteWorkflowInvocation_async", + "title": "Dataform deleteWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single WorkflowInvocation.", + "canonical": true, + "file": "dataform.delete_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "DeleteWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.DeleteWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_CancelWorkflowInvocation_async", + "title": "Dataform cancelWorkflowInvocation Sample", + "origin": "API_DEFINITION", + "description": " Requests cancellation of a running WorkflowInvocation.", + "canonical": true, + "file": "dataform.cancel_workflow_invocation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CancelWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CancelWorkflowInvocation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "CancelWorkflowInvocation", + "fullName": "google.cloud.dataform.v1beta1.Dataform.CancelWorkflowInvocation", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + }, + { + "regionTag": "dataform_v1beta1_generated_Dataform_QueryWorkflowInvocationActions_async", + "title": "Dataform queryWorkflowInvocationActions Sample", + "origin": "API_DEFINITION", + "description": " Returns WorkflowInvocationActions in a given WorkflowInvocation.", + "canonical": true, + "file": "dataform.query_workflow_invocation_actions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 69, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "QueryWorkflowInvocationActions", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryWorkflowInvocationActions", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.dataform.v1beta1.QueryWorkflowInvocationActionsResponse", + "client": { + "shortName": "DataformClient", + "fullName": "google.cloud.dataform.v1beta1.DataformClient" + }, + "method": { + "shortName": "QueryWorkflowInvocationActions", + "fullName": "google.cloud.dataform.v1beta1.Dataform.QueryWorkflowInvocationActions", + "service": { + "shortName": "Dataform", + "fullName": "google.cloud.dataform.v1beta1.Dataform" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-dataform/samples/package.json b/packages/google-cloud-dataform/samples/package.json index ccd4d28d66e..a8b40e62648 100644 --- a/packages/google-cloud-dataform/samples/package.json +++ b/packages/google-cloud-dataform/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": "^10.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-dataform/src/v1alpha2/dataform_client.ts b/packages/google-cloud-dataform/src/v1alpha2/dataform_client.ts index 4616fedc194..a2bdbbc09d2 100644 --- a/packages/google-cloud-dataform/src/v1alpha2/dataform_client.ts +++ b/packages/google-cloud-dataform/src/v1alpha2/dataform_client.ts @@ -428,9 +428,8 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository}. - * 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.dataform.v1alpha2.Repository|Repository}. + * 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/v1alpha2/dataform.get_repository.js * region_tag:dataform_v1alpha2_generated_Dataform_GetRepository_async @@ -525,9 +524,8 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository}. - * 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.dataform.v1alpha2.Repository|Repository}. + * 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/v1alpha2/dataform.create_repository.js * region_tag:dataform_v1alpha2_generated_Dataform_CreateRepository_async @@ -625,9 +623,8 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository}. - * 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.dataform.v1alpha2.Repository|Repository}. + * 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/v1alpha2/dataform.update_repository.js * region_tag:dataform_v1alpha2_generated_Dataform_UpdateRepository_async @@ -726,9 +723,8 @@ export class DataformClient { * @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/v1alpha2/dataform.delete_repository.js * region_tag:dataform_v1alpha2_generated_Dataform_DeleteRepository_async @@ -823,9 +819,8 @@ export class DataformClient { * @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.dataform.v1alpha2.FetchRemoteBranchesResponse | FetchRemoteBranchesResponse}. - * 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.dataform.v1alpha2.FetchRemoteBranchesResponse|FetchRemoteBranchesResponse}. + * 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/v1alpha2/dataform.fetch_remote_branches.js * region_tag:dataform_v1alpha2_generated_Dataform_FetchRemoteBranches_async @@ -920,9 +915,8 @@ export class DataformClient { * @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.dataform.v1alpha2.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.cloud.dataform.v1alpha2.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/v1alpha2/dataform.get_workspace.js * region_tag:dataform_v1alpha2_generated_Dataform_GetWorkspace_async @@ -1017,9 +1011,8 @@ export class DataformClient { * @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.dataform.v1alpha2.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.cloud.dataform.v1alpha2.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/v1alpha2/dataform.create_workspace.js * region_tag:dataform_v1alpha2_generated_Dataform_CreateWorkspace_async @@ -1108,9 +1101,8 @@ export class DataformClient { * @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/v1alpha2/dataform.delete_workspace.js * region_tag:dataform_v1alpha2_generated_Dataform_DeleteWorkspace_async @@ -1199,9 +1191,8 @@ export class DataformClient { * @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.dataform.v1alpha2.InstallNpmPackagesResponse | InstallNpmPackagesResponse}. - * 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.dataform.v1alpha2.InstallNpmPackagesResponse|InstallNpmPackagesResponse}. + * 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/v1alpha2/dataform.install_npm_packages.js * region_tag:dataform_v1alpha2_generated_Dataform_InstallNpmPackages_async @@ -1302,9 +1293,8 @@ export class DataformClient { * @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/v1alpha2/dataform.pull_git_commits.js * region_tag:dataform_v1alpha2_generated_Dataform_PullGitCommits_async @@ -1396,9 +1386,8 @@ export class DataformClient { * @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/v1alpha2/dataform.push_git_commits.js * region_tag:dataform_v1alpha2_generated_Dataform_PushGitCommits_async @@ -1487,9 +1476,8 @@ export class DataformClient { * @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.dataform.v1alpha2.FetchFileGitStatusesResponse | FetchFileGitStatusesResponse}. - * 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.dataform.v1alpha2.FetchFileGitStatusesResponse|FetchFileGitStatusesResponse}. + * 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/v1alpha2/dataform.fetch_file_git_statuses.js * region_tag:dataform_v1alpha2_generated_Dataform_FetchFileGitStatuses_async @@ -1588,9 +1576,8 @@ export class DataformClient { * @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.dataform.v1alpha2.FetchGitAheadBehindResponse | FetchGitAheadBehindResponse}. - * 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.dataform.v1alpha2.FetchGitAheadBehindResponse|FetchGitAheadBehindResponse}. + * 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/v1alpha2/dataform.fetch_git_ahead_behind.js * region_tag:dataform_v1alpha2_generated_Dataform_FetchGitAheadBehind_async @@ -1692,9 +1679,8 @@ export class DataformClient { * @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/v1alpha2/dataform.commit_workspace_changes.js * region_tag:dataform_v1alpha2_generated_Dataform_CommitWorkspaceChanges_async @@ -1798,9 +1784,8 @@ export class DataformClient { * @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/v1alpha2/dataform.reset_workspace_changes.js * region_tag:dataform_v1alpha2_generated_Dataform_ResetWorkspaceChanges_async @@ -1897,9 +1882,8 @@ export class DataformClient { * @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.dataform.v1alpha2.FetchFileDiffResponse | FetchFileDiffResponse}. - * 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.dataform.v1alpha2.FetchFileDiffResponse|FetchFileDiffResponse}. + * 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/v1alpha2/dataform.fetch_file_diff.js * region_tag:dataform_v1alpha2_generated_Dataform_FetchFileDiff_async @@ -1991,9 +1975,8 @@ export class DataformClient { * @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.dataform.v1alpha2.MakeDirectoryResponse | MakeDirectoryResponse}. - * 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.dataform.v1alpha2.MakeDirectoryResponse|MakeDirectoryResponse}. + * 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/v1alpha2/dataform.make_directory.js * region_tag:dataform_v1alpha2_generated_Dataform_MakeDirectory_async @@ -2085,9 +2068,8 @@ export class DataformClient { * @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/v1alpha2/dataform.remove_directory.js * region_tag:dataform_v1alpha2_generated_Dataform_RemoveDirectory_async @@ -2183,9 +2165,8 @@ export class DataformClient { * @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.dataform.v1alpha2.MoveDirectoryResponse | MoveDirectoryResponse}. - * 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.dataform.v1alpha2.MoveDirectoryResponse|MoveDirectoryResponse}. + * 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/v1alpha2/dataform.move_directory.js * region_tag:dataform_v1alpha2_generated_Dataform_MoveDirectory_async @@ -2276,9 +2257,8 @@ export class DataformClient { * @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.dataform.v1alpha2.ReadFileResponse | ReadFileResponse}. - * 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.dataform.v1alpha2.ReadFileResponse|ReadFileResponse}. + * 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/v1alpha2/dataform.read_file.js * region_tag:dataform_v1alpha2_generated_Dataform_ReadFile_async @@ -2363,9 +2343,8 @@ export class DataformClient { * @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/v1alpha2/dataform.remove_file.js * region_tag:dataform_v1alpha2_generated_Dataform_RemoveFile_async @@ -2458,9 +2437,8 @@ export class DataformClient { * @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.dataform.v1alpha2.MoveFileResponse | MoveFileResponse}. - * 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.dataform.v1alpha2.MoveFileResponse|MoveFileResponse}. + * 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/v1alpha2/dataform.move_file.js * region_tag:dataform_v1alpha2_generated_Dataform_MoveFile_async @@ -2547,9 +2525,8 @@ export class DataformClient { * @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.dataform.v1alpha2.WriteFileResponse | WriteFileResponse}. - * 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.dataform.v1alpha2.WriteFileResponse|WriteFileResponse}. + * 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/v1alpha2/dataform.write_file.js * region_tag:dataform_v1alpha2_generated_Dataform_WriteFile_async @@ -2638,9 +2615,8 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResult | CompilationResult}. - * 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.dataform.v1alpha2.CompilationResult|CompilationResult}. + * 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/v1alpha2/dataform.get_compilation_result.js * region_tag:dataform_v1alpha2_generated_Dataform_GetCompilationResult_async @@ -2738,9 +2714,8 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResult | CompilationResult}. - * 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.dataform.v1alpha2.CompilationResult|CompilationResult}. + * 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/v1alpha2/dataform.create_compilation_result.js * region_tag:dataform_v1alpha2_generated_Dataform_CreateCompilationResult_async @@ -2839,9 +2814,8 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocation | WorkflowInvocation}. - * 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.dataform.v1alpha2.WorkflowInvocation|WorkflowInvocation}. + * 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/v1alpha2/dataform.get_workflow_invocation.js * region_tag:dataform_v1alpha2_generated_Dataform_GetWorkflowInvocation_async @@ -2938,9 +2912,8 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocation | WorkflowInvocation}. - * 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.dataform.v1alpha2.WorkflowInvocation|WorkflowInvocation}. + * 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/v1alpha2/dataform.create_workflow_invocation.js * region_tag:dataform_v1alpha2_generated_Dataform_CreateWorkflowInvocation_async @@ -3039,9 +3012,8 @@ export class DataformClient { * @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/v1alpha2/dataform.delete_workflow_invocation.js * region_tag:dataform_v1alpha2_generated_Dataform_DeleteWorkflowInvocation_async @@ -3140,9 +3112,8 @@ export class DataformClient { * @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/v1alpha2/dataform.cancel_workflow_invocation.js * region_tag:dataform_v1alpha2_generated_Dataform_CancelWorkflowInvocation_async @@ -3259,14 +3230,13 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.Repository|Repository}. * 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 `listRepositoriesAsync()` * 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. */ listRepositories( @@ -3370,13 +3340,12 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.Repository|Repository} 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 `listRepositoriesAsync()` * 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. */ listRepositoriesStream( @@ -3429,12 +3398,11 @@ export class DataformClient { * @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.dataform.v1alpha2.Repository | Repository}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.Repository|Repository}. 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/v1alpha2/dataform.list_repositories.js * region_tag:dataform_v1alpha2_generated_Dataform_ListRepositories_async @@ -3487,14 +3455,13 @@ export class DataformClient { * @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.dataform.v1alpha2.Workspace | Workspace}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.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( @@ -3598,13 +3565,12 @@ export class DataformClient { * @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.dataform.v1alpha2.Workspace | Workspace} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.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( @@ -3657,12 +3623,11 @@ export class DataformClient { * @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.dataform.v1alpha2.Workspace | Workspace}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.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/v1alpha2/dataform.list_workspaces.js * region_tag:dataform_v1alpha2_generated_Dataform_ListWorkspaces_async @@ -3712,14 +3677,13 @@ export class DataformClient { * @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.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry}. * 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContents( @@ -3824,13 +3788,12 @@ export class DataformClient { * @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.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry} 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContentsStream( @@ -3880,12 +3843,11 @@ export class DataformClient { * @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.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry}. 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/v1alpha2/dataform.query_directory_contents.js * region_tag:dataform_v1alpha2_generated_Dataform_QueryDirectoryContents_async @@ -3932,14 +3894,13 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResult | CompilationResult}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.CompilationResult|CompilationResult}. * 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 `listCompilationResultsAsync()` * 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. */ listCompilationResults( @@ -4041,13 +4002,12 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResult | CompilationResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.CompilationResult|CompilationResult} 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 `listCompilationResultsAsync()` * 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. */ listCompilationResultsStream( @@ -4094,12 +4054,11 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResult | CompilationResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.CompilationResult|CompilationResult}. 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/v1alpha2/dataform.list_compilation_results.js * region_tag:dataform_v1alpha2_generated_Dataform_ListCompilationResults_async @@ -4149,14 +4108,13 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResultAction | CompilationResultAction}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.CompilationResultAction|CompilationResultAction}. * 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActions( @@ -4261,13 +4219,12 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResultAction | CompilationResultAction} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.CompilationResultAction|CompilationResultAction} 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActionsStream( @@ -4317,12 +4274,11 @@ export class DataformClient { * @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.dataform.v1alpha2.CompilationResultAction | CompilationResultAction}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.CompilationResultAction|CompilationResultAction}. 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/v1alpha2/dataform.query_compilation_result_actions.js * region_tag:dataform_v1alpha2_generated_Dataform_QueryCompilationResultActions_async @@ -4369,14 +4325,13 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocation | WorkflowInvocation}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocation|WorkflowInvocation}. * 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocations( @@ -4478,13 +4433,12 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocation | WorkflowInvocation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocation|WorkflowInvocation} 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocationsStream( @@ -4531,12 +4485,11 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocation | WorkflowInvocation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocation|WorkflowInvocation}. 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/v1alpha2/dataform.list_workflow_invocations.js * region_tag:dataform_v1alpha2_generated_Dataform_ListWorkflowInvocations_async @@ -4583,14 +4536,13 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocationAction | WorkflowInvocationAction}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocationAction|WorkflowInvocationAction}. * 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActions( @@ -4692,13 +4644,12 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocationAction | WorkflowInvocationAction} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocationAction|WorkflowInvocationAction} 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActionsStream( @@ -4746,12 +4697,11 @@ export class DataformClient { * @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.dataform.v1alpha2.WorkflowInvocationAction | WorkflowInvocationAction}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1alpha2.WorkflowInvocationAction|WorkflowInvocationAction}. 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/v1alpha2/dataform.query_workflow_invocation_actions.js * region_tag:dataform_v1alpha2_generated_Dataform_QueryWorkflowInvocationActions_async @@ -4817,7 +4767,7 @@ export class DataformClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -4838,8 +4788,7 @@ export class DataformClient { * @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. @@ -4865,7 +4814,7 @@ export class DataformClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -4886,8 +4835,7 @@ export class DataformClient { * @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. @@ -4914,7 +4862,7 @@ export class DataformClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4929,8 +4877,7 @@ export class DataformClient { * 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 * ``` @@ -4976,12 +4923,11 @@ export class DataformClient { * @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-dataform/src/v1beta1/dataform_client.ts b/packages/google-cloud-dataform/src/v1beta1/dataform_client.ts index 8ef465478cd..b1ebacbf79e 100644 --- a/packages/google-cloud-dataform/src/v1beta1/dataform_client.ts +++ b/packages/google-cloud-dataform/src/v1beta1/dataform_client.ts @@ -428,9 +428,8 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository}. - * 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.dataform.v1beta1.Repository|Repository}. + * 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/dataform.get_repository.js * region_tag:dataform_v1beta1_generated_Dataform_GetRepository_async @@ -525,9 +524,8 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository}. - * 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.dataform.v1beta1.Repository|Repository}. + * 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/dataform.create_repository.js * region_tag:dataform_v1beta1_generated_Dataform_CreateRepository_async @@ -619,9 +617,8 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository}. - * 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.dataform.v1beta1.Repository|Repository}. + * 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/dataform.update_repository.js * region_tag:dataform_v1beta1_generated_Dataform_UpdateRepository_async @@ -714,9 +711,8 @@ export class DataformClient { * @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/dataform.delete_repository.js * region_tag:dataform_v1beta1_generated_Dataform_DeleteRepository_async @@ -805,9 +801,8 @@ export class DataformClient { * @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.dataform.v1beta1.FetchRemoteBranchesResponse | FetchRemoteBranchesResponse}. - * 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.dataform.v1beta1.FetchRemoteBranchesResponse|FetchRemoteBranchesResponse}. + * 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/dataform.fetch_remote_branches.js * region_tag:dataform_v1beta1_generated_Dataform_FetchRemoteBranches_async @@ -902,9 +897,8 @@ export class DataformClient { * @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.dataform.v1beta1.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.cloud.dataform.v1beta1.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/v1beta1/dataform.get_workspace.js * region_tag:dataform_v1beta1_generated_Dataform_GetWorkspace_async @@ -999,9 +993,8 @@ export class DataformClient { * @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.dataform.v1beta1.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.cloud.dataform.v1beta1.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/v1beta1/dataform.create_workspace.js * region_tag:dataform_v1beta1_generated_Dataform_CreateWorkspace_async @@ -1090,9 +1083,8 @@ export class DataformClient { * @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/dataform.delete_workspace.js * region_tag:dataform_v1beta1_generated_Dataform_DeleteWorkspace_async @@ -1181,9 +1173,8 @@ export class DataformClient { * @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.dataform.v1beta1.InstallNpmPackagesResponse | InstallNpmPackagesResponse}. - * 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.dataform.v1beta1.InstallNpmPackagesResponse|InstallNpmPackagesResponse}. + * 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/dataform.install_npm_packages.js * region_tag:dataform_v1beta1_generated_Dataform_InstallNpmPackages_async @@ -1284,9 +1275,8 @@ export class DataformClient { * @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/dataform.pull_git_commits.js * region_tag:dataform_v1beta1_generated_Dataform_PullGitCommits_async @@ -1378,9 +1368,8 @@ export class DataformClient { * @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/dataform.push_git_commits.js * region_tag:dataform_v1beta1_generated_Dataform_PushGitCommits_async @@ -1469,9 +1458,8 @@ export class DataformClient { * @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.dataform.v1beta1.FetchFileGitStatusesResponse | FetchFileGitStatusesResponse}. - * 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.dataform.v1beta1.FetchFileGitStatusesResponse|FetchFileGitStatusesResponse}. + * 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/dataform.fetch_file_git_statuses.js * region_tag:dataform_v1beta1_generated_Dataform_FetchFileGitStatuses_async @@ -1570,9 +1558,8 @@ export class DataformClient { * @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.dataform.v1beta1.FetchGitAheadBehindResponse | FetchGitAheadBehindResponse}. - * 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.dataform.v1beta1.FetchGitAheadBehindResponse|FetchGitAheadBehindResponse}. + * 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/dataform.fetch_git_ahead_behind.js * region_tag:dataform_v1beta1_generated_Dataform_FetchGitAheadBehind_async @@ -1674,9 +1661,8 @@ export class DataformClient { * @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/dataform.commit_workspace_changes.js * region_tag:dataform_v1beta1_generated_Dataform_CommitWorkspaceChanges_async @@ -1780,9 +1766,8 @@ export class DataformClient { * @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/dataform.reset_workspace_changes.js * region_tag:dataform_v1beta1_generated_Dataform_ResetWorkspaceChanges_async @@ -1879,9 +1864,8 @@ export class DataformClient { * @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.dataform.v1beta1.FetchFileDiffResponse | FetchFileDiffResponse}. - * 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.dataform.v1beta1.FetchFileDiffResponse|FetchFileDiffResponse}. + * 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/dataform.fetch_file_diff.js * region_tag:dataform_v1beta1_generated_Dataform_FetchFileDiff_async @@ -1973,9 +1957,8 @@ export class DataformClient { * @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.dataform.v1beta1.MakeDirectoryResponse | MakeDirectoryResponse}. - * 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.dataform.v1beta1.MakeDirectoryResponse|MakeDirectoryResponse}. + * 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/dataform.make_directory.js * region_tag:dataform_v1beta1_generated_Dataform_MakeDirectory_async @@ -2067,9 +2050,8 @@ export class DataformClient { * @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/dataform.remove_directory.js * region_tag:dataform_v1beta1_generated_Dataform_RemoveDirectory_async @@ -2165,9 +2147,8 @@ export class DataformClient { * @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.dataform.v1beta1.MoveDirectoryResponse | MoveDirectoryResponse}. - * 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.dataform.v1beta1.MoveDirectoryResponse|MoveDirectoryResponse}. + * 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/dataform.move_directory.js * region_tag:dataform_v1beta1_generated_Dataform_MoveDirectory_async @@ -2258,9 +2239,8 @@ export class DataformClient { * @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.dataform.v1beta1.ReadFileResponse | ReadFileResponse}. - * 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.dataform.v1beta1.ReadFileResponse|ReadFileResponse}. + * 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/dataform.read_file.js * region_tag:dataform_v1beta1_generated_Dataform_ReadFile_async @@ -2345,9 +2325,8 @@ export class DataformClient { * @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/dataform.remove_file.js * region_tag:dataform_v1beta1_generated_Dataform_RemoveFile_async @@ -2440,9 +2419,8 @@ export class DataformClient { * @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.dataform.v1beta1.MoveFileResponse | MoveFileResponse}. - * 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.dataform.v1beta1.MoveFileResponse|MoveFileResponse}. + * 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/dataform.move_file.js * region_tag:dataform_v1beta1_generated_Dataform_MoveFile_async @@ -2529,9 +2507,8 @@ export class DataformClient { * @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.dataform.v1beta1.WriteFileResponse | WriteFileResponse}. - * 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.dataform.v1beta1.WriteFileResponse|WriteFileResponse}. + * 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/dataform.write_file.js * region_tag:dataform_v1beta1_generated_Dataform_WriteFile_async @@ -2614,9 +2591,8 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResult | CompilationResult}. - * 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.dataform.v1beta1.CompilationResult|CompilationResult}. + * 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/dataform.get_compilation_result.js * region_tag:dataform_v1beta1_generated_Dataform_GetCompilationResult_async @@ -2714,9 +2690,8 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResult | CompilationResult}. - * 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.dataform.v1beta1.CompilationResult|CompilationResult}. + * 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/dataform.create_compilation_result.js * region_tag:dataform_v1beta1_generated_Dataform_CreateCompilationResult_async @@ -2815,9 +2790,8 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocation | WorkflowInvocation}. - * 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.dataform.v1beta1.WorkflowInvocation|WorkflowInvocation}. + * 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/dataform.get_workflow_invocation.js * region_tag:dataform_v1beta1_generated_Dataform_GetWorkflowInvocation_async @@ -2915,9 +2889,8 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocation | WorkflowInvocation}. - * 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.dataform.v1beta1.WorkflowInvocation|WorkflowInvocation}. + * 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/dataform.create_workflow_invocation.js * region_tag:dataform_v1beta1_generated_Dataform_CreateWorkflowInvocation_async @@ -3016,9 +2989,8 @@ export class DataformClient { * @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/dataform.delete_workflow_invocation.js * region_tag:dataform_v1beta1_generated_Dataform_DeleteWorkflowInvocation_async @@ -3117,9 +3089,8 @@ export class DataformClient { * @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/dataform.cancel_workflow_invocation.js * region_tag:dataform_v1beta1_generated_Dataform_CancelWorkflowInvocation_async @@ -3236,14 +3207,13 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.Repository|Repository}. * 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 `listRepositoriesAsync()` * 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. */ listRepositories( @@ -3347,13 +3317,12 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.Repository|Repository} 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 `listRepositoriesAsync()` * 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. */ listRepositoriesStream( @@ -3406,12 +3375,11 @@ export class DataformClient { * @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.dataform.v1beta1.Repository | Repository}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.Repository|Repository}. 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/dataform.list_repositories.js * region_tag:dataform_v1beta1_generated_Dataform_ListRepositories_async @@ -3464,14 +3432,13 @@ export class DataformClient { * @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.dataform.v1beta1.Workspace | Workspace}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.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( @@ -3575,13 +3542,12 @@ export class DataformClient { * @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.dataform.v1beta1.Workspace | Workspace} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.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( @@ -3634,12 +3600,11 @@ export class DataformClient { * @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.dataform.v1beta1.Workspace | Workspace}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.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/v1beta1/dataform.list_workspaces.js * region_tag:dataform_v1beta1_generated_Dataform_ListWorkspaces_async @@ -3689,14 +3654,13 @@ export class DataformClient { * @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.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry}. * 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContents( @@ -3801,13 +3765,12 @@ export class DataformClient { * @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.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry} 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 `queryDirectoryContentsAsync()` * 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. */ queryDirectoryContentsStream( @@ -3857,12 +3820,11 @@ export class DataformClient { * @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.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry | DirectoryEntry}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.QueryDirectoryContentsResponse.DirectoryEntry|DirectoryEntry}. 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/dataform.query_directory_contents.js * region_tag:dataform_v1beta1_generated_Dataform_QueryDirectoryContents_async @@ -3909,14 +3871,13 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResult | CompilationResult}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.CompilationResult|CompilationResult}. * 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 `listCompilationResultsAsync()` * 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. */ listCompilationResults( @@ -4018,13 +3979,12 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResult | CompilationResult} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.CompilationResult|CompilationResult} 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 `listCompilationResultsAsync()` * 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. */ listCompilationResultsStream( @@ -4071,12 +4031,11 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResult | CompilationResult}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.CompilationResult|CompilationResult}. 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/dataform.list_compilation_results.js * region_tag:dataform_v1beta1_generated_Dataform_ListCompilationResults_async @@ -4126,14 +4085,13 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResultAction | CompilationResultAction}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.CompilationResultAction|CompilationResultAction}. * 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActions( @@ -4238,13 +4196,12 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResultAction | CompilationResultAction} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.CompilationResultAction|CompilationResultAction} 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 `queryCompilationResultActionsAsync()` * 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. */ queryCompilationResultActionsStream( @@ -4294,12 +4251,11 @@ export class DataformClient { * @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.dataform.v1beta1.CompilationResultAction | CompilationResultAction}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.CompilationResultAction|CompilationResultAction}. 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/dataform.query_compilation_result_actions.js * region_tag:dataform_v1beta1_generated_Dataform_QueryCompilationResultActions_async @@ -4346,14 +4302,13 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocation | WorkflowInvocation}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocation|WorkflowInvocation}. * 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocations( @@ -4455,13 +4410,12 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocation | WorkflowInvocation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocation|WorkflowInvocation} 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 `listWorkflowInvocationsAsync()` * 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. */ listWorkflowInvocationsStream( @@ -4508,12 +4462,11 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocation | WorkflowInvocation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocation|WorkflowInvocation}. 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/dataform.list_workflow_invocations.js * region_tag:dataform_v1beta1_generated_Dataform_ListWorkflowInvocations_async @@ -4560,14 +4513,13 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocationAction | WorkflowInvocationAction}. + * The first element of the array is Array of {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocationAction|WorkflowInvocationAction}. * 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActions( @@ -4669,13 +4621,12 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocationAction | WorkflowInvocationAction} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocationAction|WorkflowInvocationAction} 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 `queryWorkflowInvocationActionsAsync()` * 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. */ queryWorkflowInvocationActionsStream( @@ -4723,12 +4674,11 @@ export class DataformClient { * @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.dataform.v1beta1.WorkflowInvocationAction | WorkflowInvocationAction}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.dataform.v1beta1.WorkflowInvocationAction|WorkflowInvocationAction}. 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/dataform.query_workflow_invocation_actions.js * region_tag:dataform_v1beta1_generated_Dataform_QueryWorkflowInvocationActions_async @@ -4794,7 +4744,7 @@ export class DataformClient { IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.getIamPolicy(request, options, callback); } @@ -4815,8 +4765,7 @@ export class DataformClient { * @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. @@ -4842,7 +4791,7 @@ export class DataformClient { IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.Policy]> { return this.iamClient.setIamPolicy(request, options, callback); } @@ -4863,8 +4812,7 @@ export class DataformClient { * @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. @@ -4891,7 +4839,7 @@ export class DataformClient { IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined > - ): Promise { + ): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]> { return this.iamClient.testIamPermissions(request, options, callback); } @@ -4906,8 +4854,7 @@ export class DataformClient { * 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 * ``` @@ -4953,12 +4900,11 @@ export class DataformClient { * @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-datafusion/README.md b/packages/google-cloud-datafusion/README.md index 6dbd4ba4e14..14b16e863a1 100644 --- a/packages/google-cloud-datafusion/README.md +++ b/packages/google-cloud-datafusion/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Cloud Data Fusion: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Cloud Data Fusion: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-datafusion) [![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/data-fusion.svg)](https://www.npmjs.org/package/@google-cloud/data-fusion) @@ -58,32 +58,31 @@ npm install @google-cloud/data-fusion ## 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-datafusion/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Data_fusion.create_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.create_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-datafusion/samples/generated/v1/data_fusion.create_instance.js,samples/README.md) | -| Data_fusion.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-cloud-datafusion/samples/generated/v1/data_fusion.delete_instance.js,samples/README.md) | -| Data_fusion.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.get_instance.js,samples/README.md) | -| Data_fusion.list_available_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.list_available_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-cloud-datafusion/samples/generated/v1/data_fusion.list_available_versions.js,samples/README.md) | -| Data_fusion.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.list_instances.js,samples/README.md) | -| Data_fusion.restart_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.restart_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-datafusion/samples/generated/v1/data_fusion.restart_instance.js,samples/README.md) | -| Data_fusion.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.update_instance.js,samples/README.md) | -| Data_fusion.add_dns_peering | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.add_dns_peering.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.add_dns_peering.js,samples/README.md) | -| Data_fusion.create_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.create_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-datafusion/samples/generated/v1beta1/data_fusion.create_instance.js,samples/README.md) | -| Data_fusion.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-cloud-datafusion/samples/generated/v1beta1/data_fusion.delete_instance.js,samples/README.md) | -| Data_fusion.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.get_instance.js,samples/README.md) | -| Data_fusion.list_available_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_available_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-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_available_versions.js,samples/README.md) | -| Data_fusion.list_dns_peerings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_dns_peerings.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.list_dns_peerings.js,samples/README.md) | -| Data_fusion.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.list_instances.js,samples/README.md) | -| Data_fusion.list_namespaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_namespaces.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.list_namespaces.js,samples/README.md) | -| Data_fusion.remove_dns_peering | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.remove_dns_peering.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.remove_dns_peering.js,samples/README.md) | -| Data_fusion.remove_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.remove_iam_policy.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.remove_iam_policy.js,samples/README.md) | -| Data_fusion.restart_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.restart_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-datafusion/samples/generated/v1beta1/data_fusion.restart_instance.js,samples/README.md) | -| Data_fusion.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.update_instance.js,samples/README.md) | -| Data_fusion.upgrade_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.upgrade_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-datafusion/samples/generated/v1beta1/data_fusion.upgrade_instance.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/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-datafusion/samples/quickstart.js,samples/README.md) | -| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/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-datafusion/samples/test/quickstart.js,samples/README.md) | +| Data_fusion.create_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.create_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-datafusion/samples/generated/v1/data_fusion.create_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-cloud-datafusion/samples/generated/v1/data_fusion.delete_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.get_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_available_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.list_available_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-cloud-datafusion/samples/generated/v1/data_fusion.list_available_versions.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.list_instances.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.restart_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.restart_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-datafusion/samples/generated/v1/data_fusion.restart_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1/data_fusion.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-datafusion/samples/generated/v1/data_fusion.update_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.add_dns_peering | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.add_dns_peering.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.add_dns_peering.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.create_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.create_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-datafusion/samples/generated/v1beta1/data_fusion.create_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.delete_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-cloud-datafusion/samples/generated/v1beta1/data_fusion.delete_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.get_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.get_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_available_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_available_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-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_available_versions.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_dns_peerings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_dns_peerings.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.list_dns_peerings.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_instances | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.list_instances.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.list_namespaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.list_namespaces.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.list_namespaces.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.remove_dns_peering | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.remove_dns_peering.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.remove_dns_peering.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.remove_iam_policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.remove_iam_policy.js) | [![Open in Cloud Shell][shell_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-datafusion/samples/generated/v1beta1/data_fusion.remove_iam_policy.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.restart_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.restart_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-datafusion/samples/generated/v1beta1/data_fusion.restart_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.update_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.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-datafusion/samples/generated/v1beta1/data_fusion.update_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Data_fusion.upgrade_instance | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/samples/generated/v1beta1/data_fusion.upgrade_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-datafusion/samples/generated/v1beta1/data_fusion.upgrade_instance.js,packages/google-cloud-datafusion/samples/README.md) | +| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/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-datafusion/samples/quickstart.js,packages/google-cloud-datafusion/samples/README.md) | diff --git a/packages/google-cloud-datafusion/package.json b/packages/google-cloud-datafusion/package.json index d96ae0a9189..ed1631dda91 100644 --- a/packages/google-cloud-datafusion/package.json +++ b/packages/google-cloud-datafusion/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-datafusion" } diff --git a/packages/google-cloud-datafusion/samples/README.md b/packages/google-cloud-datafusion/samples/README.md index 8e6b5996a15..626ff4b9612 100644 --- a/packages/google-cloud-datafusion/samples/README.md +++ b/packages/google-cloud-datafusion/samples/README.md @@ -33,7 +33,6 @@ * [Data_fusion.update_instance](#data_fusion.update_instance) * [Data_fusion.upgrade_instance](#data_fusion.upgrade_instance) * [Quickstart](#quickstart) - * [Quickstart](#quickstart) ## Before you begin @@ -402,23 +401,6 @@ __Usage:__ `node packages/google-cloud-datafusion/samples/quickstart.js` ------ - - - - -### Quickstart - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datafusion/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-datafusion/samples/test/quickstart.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-datafusion/samples/test/quickstart.js` - - diff --git a/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata.google.cloud.datafusion.v1.json b/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata.google.cloud.datafusion.v1.json index d95883f9373..1d0c7d01471 100644 --- a/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata.google.cloud.datafusion.v1.json +++ b/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata.google.cloud.datafusion.v1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datafusion", - "version": "2.2.0", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata_google.cloud.datafusion.v1.json b/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata_google.cloud.datafusion.v1.json new file mode 100644 index 00000000000..1d0c7d01471 --- /dev/null +++ b/packages/google-cloud-datafusion/samples/generated/v1/snippet_metadata_google.cloud.datafusion.v1.json @@ -0,0 +1,335 @@ +{ + "clientLibrary": { + "name": "nodejs-datafusion", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datafusion.v1", + "version": "v1" + } + ] + }, + "snippets": [ + { + "regionTag": "datafusion_v1_generated_DataFusion_ListAvailableVersions_async", + "title": "DataFusion listAvailableVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists possible versions for Data Fusion instances in the specified project and location.", + "canonical": true, + "file": "data_fusion.list_available_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAvailableVersions", + "fullName": "google.cloud.datafusion.v1.DataFusion.ListAvailableVersions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "latest_patch_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.datafusion.v1.ListAvailableVersionsResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "ListAvailableVersions", + "fullName": "google.cloud.datafusion.v1.DataFusion.ListAvailableVersions", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_ListInstances_async", + "title": "DataFusion listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists Data Fusion instances in the specified project and location.", + "canonical": true, + "file": "data_fusion.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.datafusion.v1.DataFusion.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.datafusion.v1.ListInstancesResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.datafusion.v1.DataFusion.ListInstances", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_GetInstance_async", + "title": "DataFusion getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Data Fusion instance.", + "canonical": true, + "file": "data_fusion.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datafusion.v1.Instance", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.GetInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_CreateInstance_async", + "title": "DataFusion createInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Data Fusion instance in the specified project and location.", + "canonical": true, + "file": "data_fusion.create_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.CreateInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.datafusion.v1.Instance" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "CreateInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.CreateInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_DeleteInstance_async", + "title": "DataFusion deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Date Fusion instance.", + "canonical": true, + "file": "data_fusion.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.DeleteInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_UpdateInstance_async", + "title": "DataFusion updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Updates a single Data Fusion instance.", + "canonical": true, + "file": "data_fusion.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "instance", + "type": ".google.cloud.datafusion.v1.Instance" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.UpdateInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1_generated_DataFusion_RestartInstance_async", + "title": "DataFusion restartInstance Sample", + "origin": "API_DEFINITION", + "description": " Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.", + "canonical": true, + "file": "data_fusion.restart_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.RestartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1.DataFusionClient" + }, + "method": { + "shortName": "RestartInstance", + "fullName": "google.cloud.datafusion.v1.DataFusion.RestartInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1.DataFusion" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata.google.cloud.datafusion.v1beta1.json b/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata.google.cloud.datafusion.v1beta1.json index 0d95c0ea959..9c36010199b 100644 --- a/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata.google.cloud.datafusion.v1beta1.json +++ b/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata.google.cloud.datafusion.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datafusion", - "version": "2.2.0", + "version": "2.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata_google.cloud.datafusion.v1beta1.json b/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata_google.cloud.datafusion.v1beta1.json new file mode 100644 index 00000000000..9c36010199b --- /dev/null +++ b/packages/google-cloud-datafusion/samples/generated/v1beta1/snippet_metadata_google.cloud.datafusion.v1beta1.json @@ -0,0 +1,603 @@ +{ + "clientLibrary": { + "name": "nodejs-datafusion", + "version": "2.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datafusion.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_ListAvailableVersions_async", + "title": "DataFusion listAvailableVersions Sample", + "origin": "API_DEFINITION", + "description": " Lists possible versions for Data Fusion instances in the specified project and location.", + "canonical": true, + "file": "data_fusion.list_available_versions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAvailableVersions", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListAvailableVersions", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + }, + { + "name": "latest_patch_only", + "type": "TYPE_BOOL" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.ListAvailableVersionsResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "ListAvailableVersions", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListAvailableVersions", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_ListInstances_async", + "title": "DataFusion listInstances Sample", + "origin": "API_DEFINITION", + "description": " Lists Data Fusion instances in the specified project and location.", + "canonical": true, + "file": "data_fusion.list_instances.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstances", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.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.datafusion.v1beta1.ListInstancesResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "ListInstances", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListInstances", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_GetInstance_async", + "title": "DataFusion getInstance Sample", + "origin": "API_DEFINITION", + "description": " Gets details of a single Data Fusion instance.", + "canonical": true, + "file": "data_fusion.get_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.GetInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.Instance", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "GetInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.GetInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_CreateInstance_async", + "title": "DataFusion createInstance Sample", + "origin": "API_DEFINITION", + "description": " Creates a new Data Fusion instance in the specified project and location.", + "canonical": true, + "file": "data_fusion.create_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.CreateInstance", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instance_id", + "type": "TYPE_STRING" + }, + { + "name": "instance", + "type": ".google.cloud.datafusion.v1beta1.Instance" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "CreateInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.CreateInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_DeleteInstance_async", + "title": "DataFusion deleteInstance Sample", + "origin": "API_DEFINITION", + "description": " Deletes a single Data Fusion instance.", + "canonical": true, + "file": "data_fusion.delete_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.DeleteInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "DeleteInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.DeleteInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_UpdateInstance_async", + "title": "DataFusion updateInstance Sample", + "origin": "API_DEFINITION", + "description": " Updates a single Data Fusion instance.", + "canonical": true, + "file": "data_fusion.update_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.UpdateInstance", + "async": true, + "parameters": [ + { + "name": "instance", + "type": ".google.cloud.datafusion.v1beta1.Instance" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "UpdateInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.UpdateInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_RestartInstance_async", + "title": "DataFusion restartInstance Sample", + "origin": "API_DEFINITION", + "description": " Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.", + "canonical": true, + "file": "data_fusion.restart_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RestartInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RestartInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "RestartInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RestartInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_UpgradeInstance_async", + "title": "DataFusion upgradeInstance Sample", + "origin": "API_DEFINITION", + "description": " Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.", + "canonical": true, + "file": "data_fusion.upgrade_instance.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpgradeInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.UpgradeInstance", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "UpgradeInstance", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.UpgradeInstance", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_RemoveIamPolicy_async", + "title": "DataFusion removeIamPolicy Sample", + "origin": "API_DEFINITION", + "description": " Remove IAM policy that is currently set on the given resource.", + "canonical": true, + "file": "data_fusion.remove_iam_policy.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 53, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveIamPolicy", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RemoveIamPolicy", + "async": true, + "parameters": [ + { + "name": "resource", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.RemoveIamPolicyResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "RemoveIamPolicy", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RemoveIamPolicy", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_ListNamespaces_async", + "title": "DataFusion listNamespaces Sample", + "origin": "API_DEFINITION", + "description": " List namespaces in a given instance", + "canonical": true, + "file": "data_fusion.list_namespaces.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListNamespaces", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListNamespaces", + "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.datafusion.v1beta1.NamespaceView" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.ListNamespacesResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "ListNamespaces", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListNamespaces", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_AddDnsPeering_async", + "title": "DataFusion addDnsPeering Sample", + "origin": "API_DEFINITION", + "description": " Add DNS peering on the given resource.", + "canonical": true, + "file": "data_fusion.add_dns_peering.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 57, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "AddDnsPeering", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.AddDnsPeering", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dns_peering", + "type": ".google.cloud.datafusion.v1beta1.DnsPeering" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.AddDnsPeeringResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "AddDnsPeering", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.AddDnsPeering", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_RemoveDnsPeering_async", + "title": "DataFusion removeDnsPeering Sample", + "origin": "API_DEFINITION", + "description": " Remove DNS peering on the given resource.", + "canonical": true, + "file": "data_fusion.remove_dns_peering.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 58, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "RemoveDnsPeering", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RemoveDnsPeering", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "zone", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.RemoveDnsPeeringResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "RemoveDnsPeering", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.RemoveDnsPeering", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + }, + { + "regionTag": "datafusion_v1beta1_generated_DataFusion_ListDnsPeerings_async", + "title": "DataFusion listDnsPeerings Sample", + "origin": "API_DEFINITION", + "description": " List DNS peering for a given resource.", + "canonical": true, + "file": "data_fusion.list_dns_peerings.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 64, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDnsPeerings", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListDnsPeerings", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datafusion.v1beta1.ListDnsPeeringsResponse", + "client": { + "shortName": "DataFusionClient", + "fullName": "google.cloud.datafusion.v1beta1.DataFusionClient" + }, + "method": { + "shortName": "ListDnsPeerings", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion.ListDnsPeerings", + "service": { + "shortName": "DataFusion", + "fullName": "google.cloud.datafusion.v1beta1.DataFusion" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datafusion/samples/package.json b/packages/google-cloud-datafusion/samples/package.json index 473a691604d..11df211ba13 100644 --- a/packages/google-cloud-datafusion/samples/package.json +++ b/packages/google-cloud-datafusion/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": "^9.0.0" } -} +} \ No newline at end of file diff --git a/packages/google-cloud-datafusion/src/v1/data_fusion_client.ts b/packages/google-cloud-datafusion/src/v1/data_fusion_client.ts index fdb40a245af..b96d0cb7c80 100644 --- a/packages/google-cloud-datafusion/src/v1/data_fusion_client.ts +++ b/packages/google-cloud-datafusion/src/v1/data_fusion_client.ts @@ -467,9 +467,8 @@ export class DataFusionClient { * @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.datafusion.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.datafusion.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/data_fusion.get_instance.js * region_tag:datafusion_v1_generated_DataFusion_GetInstance_async @@ -561,8 +560,7 @@ export class DataFusionClient { * 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/data_fusion.create_instance.js * region_tag:datafusion_v1_generated_DataFusion_CreateInstance_async @@ -657,8 +655,7 @@ export class DataFusionClient { * 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/data_fusion.create_instance.js * region_tag:datafusion_v1_generated_DataFusion_CreateInstance_async @@ -700,8 +697,7 @@ export class DataFusionClient { * 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/data_fusion.delete_instance.js * region_tag:datafusion_v1_generated_DataFusion_DeleteInstance_async @@ -796,8 +792,7 @@ export class DataFusionClient { * 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/data_fusion.delete_instance.js * region_tag:datafusion_v1_generated_DataFusion_DeleteInstance_async @@ -847,8 +842,7 @@ export class DataFusionClient { * 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/data_fusion.update_instance.js * region_tag:datafusion_v1_generated_DataFusion_UpdateInstance_async @@ -943,8 +937,7 @@ export class DataFusionClient { * 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/data_fusion.update_instance.js * region_tag:datafusion_v1_generated_DataFusion_UpdateInstance_async @@ -987,8 +980,7 @@ export class DataFusionClient { * 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/data_fusion.restart_instance.js * region_tag:datafusion_v1_generated_DataFusion_RestartInstance_async @@ -1083,8 +1075,7 @@ export class DataFusionClient { * 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/data_fusion.restart_instance.js * region_tag:datafusion_v1_generated_DataFusion_RestartInstance_async @@ -1133,14 +1124,13 @@ export class DataFusionClient { * @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.datafusion.v1.Version | Version}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.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 `listAvailableVersionsAsync()` * 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. */ listAvailableVersions( @@ -1237,13 +1227,12 @@ export class DataFusionClient { * @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.datafusion.v1.Version | Version} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.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 `listAvailableVersionsAsync()` * 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. */ listAvailableVersionsStream( @@ -1289,12 +1278,11 @@ export class DataFusionClient { * @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.datafusion.v1.Version | Version}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.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/data_fusion.list_available_versions.js * region_tag:datafusion_v1_generated_DataFusion_ListAvailableVersions_async @@ -1342,14 +1330,13 @@ export class DataFusionClient { * @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.datafusion.v1.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.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( @@ -1448,13 +1435,12 @@ export class DataFusionClient { * @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.datafusion.v1.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.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( @@ -1502,12 +1488,11 @@ export class DataFusionClient { * @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.datafusion.v1.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.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/data_fusion.list_instances.js * region_tag:datafusion_v1_generated_DataFusion_ListInstances_async diff --git a/packages/google-cloud-datafusion/src/v1beta1/data_fusion_client.ts b/packages/google-cloud-datafusion/src/v1beta1/data_fusion_client.ts index 052ff225e0b..16f084a783d 100644 --- a/packages/google-cloud-datafusion/src/v1beta1/data_fusion_client.ts +++ b/packages/google-cloud-datafusion/src/v1beta1/data_fusion_client.ts @@ -514,9 +514,8 @@ export class DataFusionClient { * @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.datafusion.v1beta1.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.datafusion.v1beta1.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/v1beta1/data_fusion.get_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_GetInstance_async @@ -605,9 +604,8 @@ export class DataFusionClient { * @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.datafusion.v1beta1.RemoveIamPolicyResponse | RemoveIamPolicyResponse}. - * 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.datafusion.v1beta1.RemoveIamPolicyResponse|RemoveIamPolicyResponse}. + * 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/data_fusion.remove_iam_policy.js * region_tag:datafusion_v1beta1_generated_DataFusion_RemoveIamPolicy_async @@ -704,9 +702,8 @@ export class DataFusionClient { * @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.datafusion.v1beta1.AddDnsPeeringResponse | AddDnsPeeringResponse}. - * 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.datafusion.v1beta1.AddDnsPeeringResponse|AddDnsPeeringResponse}. + * 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/data_fusion.add_dns_peering.js * region_tag:datafusion_v1beta1_generated_DataFusion_AddDnsPeering_async @@ -797,9 +794,8 @@ export class DataFusionClient { * @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.datafusion.v1beta1.RemoveDnsPeeringResponse | RemoveDnsPeeringResponse}. - * 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.datafusion.v1beta1.RemoveDnsPeeringResponse|RemoveDnsPeeringResponse}. + * 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/data_fusion.remove_dns_peering.js * region_tag:datafusion_v1beta1_generated_DataFusion_RemoveDnsPeering_async @@ -903,8 +899,7 @@ export class DataFusionClient { * 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/data_fusion.create_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_CreateInstance_async @@ -999,8 +994,7 @@ export class DataFusionClient { * 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/data_fusion.create_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_CreateInstance_async @@ -1042,8 +1036,7 @@ export class DataFusionClient { * 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/data_fusion.delete_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_DeleteInstance_async @@ -1138,8 +1131,7 @@ export class DataFusionClient { * 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/data_fusion.delete_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_DeleteInstance_async @@ -1189,8 +1181,7 @@ export class DataFusionClient { * 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/data_fusion.update_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_UpdateInstance_async @@ -1285,8 +1276,7 @@ export class DataFusionClient { * 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/data_fusion.update_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_UpdateInstance_async @@ -1329,8 +1319,7 @@ export class DataFusionClient { * 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/data_fusion.restart_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_RestartInstance_async @@ -1425,8 +1414,7 @@ export class DataFusionClient { * 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/data_fusion.restart_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_RestartInstance_async @@ -1471,8 +1459,7 @@ export class DataFusionClient { * 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/data_fusion.upgrade_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_UpgradeInstance_async @@ -1567,8 +1554,7 @@ export class DataFusionClient { * 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/data_fusion.upgrade_instance.js * region_tag:datafusion_v1beta1_generated_DataFusion_UpgradeInstance_async @@ -1617,14 +1603,13 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Version | Version}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.v1beta1.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 `listAvailableVersionsAsync()` * 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. */ listAvailableVersions( @@ -1721,13 +1706,12 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Version | Version} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.v1beta1.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 `listAvailableVersionsAsync()` * 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. */ listAvailableVersionsStream( @@ -1773,12 +1757,11 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Version | Version}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.v1beta1.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/v1beta1/data_fusion.list_available_versions.js * region_tag:datafusion_v1beta1_generated_DataFusion_ListAvailableVersions_async @@ -1826,14 +1809,13 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Instance | Instance}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.v1beta1.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( @@ -1932,13 +1914,12 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Instance | Instance} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.v1beta1.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( @@ -1986,12 +1967,11 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Instance | Instance}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.v1beta1.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/v1beta1/data_fusion.list_instances.js * region_tag:datafusion_v1beta1_generated_DataFusion_ListInstances_async @@ -2037,14 +2017,13 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Namespace | Namespace}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.v1beta1.Namespace|Namespace}. * 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 `listNamespacesAsync()` * 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. */ listNamespaces( @@ -2141,13 +2120,12 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Namespace | Namespace} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.v1beta1.Namespace|Namespace} 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 `listNamespacesAsync()` * 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. */ listNamespacesStream( @@ -2193,12 +2171,11 @@ export class DataFusionClient { * @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.datafusion.v1beta1.Namespace | Namespace}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.v1beta1.Namespace|Namespace}. 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/data_fusion.list_namespaces.js * region_tag:datafusion_v1beta1_generated_DataFusion_ListNamespaces_async @@ -2239,14 +2216,13 @@ export class DataFusionClient { * @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.datafusion.v1beta1.DnsPeering | DnsPeering}. + * The first element of the array is Array of {@link protos.google.cloud.datafusion.v1beta1.DnsPeering|DnsPeering}. * 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 `listDnsPeeringsAsync()` * 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. */ listDnsPeerings( @@ -2338,13 +2314,12 @@ export class DataFusionClient { * @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.datafusion.v1beta1.DnsPeering | DnsPeering} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datafusion.v1beta1.DnsPeering|DnsPeering} 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 `listDnsPeeringsAsync()` * 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. */ listDnsPeeringsStream( @@ -2385,12 +2360,11 @@ export class DataFusionClient { * @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.datafusion.v1beta1.DnsPeering | DnsPeering}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datafusion.v1beta1.DnsPeering|DnsPeering}. 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/data_fusion.list_dns_peerings.js * region_tag:datafusion_v1beta1_generated_DataFusion_ListDnsPeerings_async diff --git a/packages/google-cloud-datalabeling/README.md b/packages/google-cloud-datalabeling/README.md index 013d0fbcee9..92deebc194f 100644 --- a/packages/google-cloud-datalabeling/README.md +++ b/packages/google-cloud-datalabeling/README.md @@ -2,7 +2,7 @@ [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo -# [Google Cloud Data Labeling: Node.js Client](https://github.com/googleapis/google-cloud-node) +# [Google Cloud Data Labeling: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-datalabeling) [![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/datalabeling.svg)](https://www.npmjs.org/package/@google-cloud/datalabeling) @@ -74,46 +74,45 @@ quickstart(); ## 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-datalabeling/samples) directory. Each sample's `README.md` has instructions for running its sample. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | -| Data_labeling_service.create_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_annotation_spec_set.js,samples/README.md) | -| Data_labeling_service.create_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_dataset.js,samples/README.md) | -| Data_labeling_service.create_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_evaluation_job.js,samples/README.md) | -| Data_labeling_service.create_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_instruction.js,samples/README.md) | -| Data_labeling_service.delete_annotated_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotated_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotated_dataset.js,samples/README.md) | -| Data_labeling_service.delete_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotation_spec_set.js,samples/README.md) | -| Data_labeling_service.delete_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_dataset.js,samples/README.md) | -| Data_labeling_service.delete_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_evaluation_job.js,samples/README.md) | -| Data_labeling_service.delete_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_instruction.js,samples/README.md) | -| Data_labeling_service.export_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.export_data.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.export_data.js,samples/README.md) | -| Data_labeling_service.get_annotated_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotated_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotated_dataset.js,samples/README.md) | -| Data_labeling_service.get_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotation_spec_set.js,samples/README.md) | -| Data_labeling_service.get_data_item | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_data_item.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_data_item.js,samples/README.md) | -| Data_labeling_service.get_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_dataset.js,samples/README.md) | -| Data_labeling_service.get_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation.js,samples/README.md) | -| Data_labeling_service.get_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation_job.js,samples/README.md) | -| Data_labeling_service.get_example | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_example.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_example.js,samples/README.md) | -| Data_labeling_service.get_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_instruction.js,samples/README.md) | -| Data_labeling_service.import_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.import_data.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.import_data.js,samples/README.md) | -| Data_labeling_service.label_image | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_image.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_image.js,samples/README.md) | -| Data_labeling_service.label_text | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_text.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_text.js,samples/README.md) | -| Data_labeling_service.label_video | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_video.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_video.js,samples/README.md) | -| Data_labeling_service.list_annotated_datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotated_datasets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotated_datasets.js,samples/README.md) | -| Data_labeling_service.list_annotation_spec_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotation_spec_sets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotation_spec_sets.js,samples/README.md) | -| Data_labeling_service.list_data_items | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_data_items.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_data_items.js,samples/README.md) | -| Data_labeling_service.list_datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_datasets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_datasets.js,samples/README.md) | -| Data_labeling_service.list_evaluation_jobs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_evaluation_jobs.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_evaluation_jobs.js,samples/README.md) | -| Data_labeling_service.list_examples | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_examples.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_examples.js,samples/README.md) | -| Data_labeling_service.list_instructions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_instructions.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_instructions.js,samples/README.md) | -| Data_labeling_service.pause_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.pause_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.pause_evaluation_job.js,samples/README.md) | -| Data_labeling_service.resume_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.resume_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.resume_evaluation_job.js,samples/README.md) | -| Data_labeling_service.search_evaluations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.search_evaluations.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.search_evaluations.js,samples/README.md) | -| Data_labeling_service.search_example_comparisons | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.search_example_comparisons.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.search_example_comparisons.js,samples/README.md) | -| Data_labeling_service.update_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.update_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.update_evaluation_job.js,samples/README.md) | -| Get Datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/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-datalabeling/samples/quickstart.js,samples/README.md) | -| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/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-datalabeling/samples/test/quickstart.test.js,samples/README.md) | +| Data_labeling_service.create_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_annotation_spec_set.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.create_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_dataset.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.create_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.create_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.create_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.create_instruction.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.delete_annotated_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotated_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotated_dataset.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.delete_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_annotation_spec_set.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.delete_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_dataset.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.delete_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.delete_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.delete_instruction.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.export_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.export_data.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.export_data.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_annotated_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotated_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotated_dataset.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_annotation_spec_set | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotation_spec_set.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_annotation_spec_set.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_data_item | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_data_item.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_data_item.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_dataset | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_dataset.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_dataset.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_evaluation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_example | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_example.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_example.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.get_instruction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.get_instruction.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.get_instruction.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.import_data | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.import_data.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.import_data.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.label_image | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_image.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_image.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.label_text | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_text.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_text.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.label_video | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.label_video.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.label_video.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_annotated_datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotated_datasets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotated_datasets.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_annotation_spec_sets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotation_spec_sets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_annotation_spec_sets.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_data_items | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_data_items.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_data_items.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_datasets.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_datasets.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_evaluation_jobs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_evaluation_jobs.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_evaluation_jobs.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_examples | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_examples.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_examples.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.list_instructions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.list_instructions.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.list_instructions.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.pause_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.pause_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.pause_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.resume_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.resume_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.resume_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.search_evaluations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.search_evaluations.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.search_evaluations.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.search_example_comparisons | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.search_example_comparisons.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.search_example_comparisons.js,packages/google-cloud-datalabeling/samples/README.md) | +| Data_labeling_service.update_evaluation_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/samples/generated/v1beta1/data_labeling_service.update_evaluation_job.js) | [![Open in Cloud Shell][shell_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-datalabeling/samples/generated/v1beta1/data_labeling_service.update_evaluation_job.js,packages/google-cloud-datalabeling/samples/README.md) | +| Get Datasets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/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-datalabeling/samples/quickstart.js,packages/google-cloud-datalabeling/samples/README.md) | diff --git a/packages/google-cloud-datalabeling/package.json b/packages/google-cloud-datalabeling/package.json index 96918696ca6..865d6c76ecc 100644 --- a/packages/google-cloud-datalabeling/package.json +++ b/packages/google-cloud-datalabeling/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,14 +48,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.0.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", @@ -66,7 +67,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-datalabeling/samples/README.md b/packages/google-cloud-datalabeling/samples/README.md index 1ca6e8a5bd9..2071266d901 100644 --- a/packages/google-cloud-datalabeling/samples/README.md +++ b/packages/google-cloud-datalabeling/samples/README.md @@ -47,7 +47,6 @@ * [Data_labeling_service.search_example_comparisons](#data_labeling_service.search_example_comparisons) * [Data_labeling_service.update_evaluation_job](#data_labeling_service.update_evaluation_job) * [Get Datasets](#get-datasets) - * [Quickstart.test](#quickstart.test) ## Before you begin @@ -656,23 +655,6 @@ __Usage:__ `node quickstart.js` ------ - - - - -### Quickstart.test - -View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datalabeling/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-datalabeling/samples/test/quickstart.test.js,samples/README.md) - -__Usage:__ - - -`node packages/google-cloud-datalabeling/samples/test/quickstart.test.js` - - diff --git a/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata.google.cloud.datalabeling.v1beta1.json b/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata.google.cloud.datalabeling.v1beta1.json index 9d1ec2dca81..9b22e79feb5 100644 --- a/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata.google.cloud.datalabeling.v1beta1.json +++ b/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata.google.cloud.datalabeling.v1beta1.json @@ -1,7 +1,7 @@ { "clientLibrary": { "name": "nodejs-datalabeling", - "version": "3.2.0", + "version": "3.2.2", "language": "TYPESCRIPT", "apis": [ { diff --git a/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata_google.cloud.datalabeling.v1beta1.json b/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata_google.cloud.datalabeling.v1beta1.json new file mode 100644 index 00000000000..9b22e79feb5 --- /dev/null +++ b/packages/google-cloud-datalabeling/samples/generated/v1beta1/snippet_metadata_google.cloud.datalabeling.v1beta1.json @@ -0,0 +1,1591 @@ +{ + "clientLibrary": { + "name": "nodejs-datalabeling", + "version": "3.2.2", + "language": "TYPESCRIPT", + "apis": [ + { + "id": "google.cloud.datalabeling.v1beta1", + "version": "v1beta1" + } + ] + }, + "snippets": [ + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_CreateDataset_async", + "title": "datalabeling createDataset Sample", + "origin": "API_DEFINITION", + "description": " Creates dataset. If success return a Dataset resource.", + "canonical": true, + "file": "data_labeling_service.create_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateDataset", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "dataset", + "type": ".google.cloud.datalabeling.v1beta1.Dataset" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.Dataset", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "CreateDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateDataset", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetDataset_async", + "title": "datalabeling getDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets dataset by resource name.", + "canonical": true, + "file": "data_labeling_service.get_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.Dataset", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetDataset", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListDatasets_async", + "title": "datalabeling listDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists datasets under a project. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDatasets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListDatasets", + "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.datalabeling.v1beta1.ListDatasetsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListDatasets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListDatasets", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_DeleteDataset_async", + "title": "datalabeling deleteDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes a dataset by resource name.", + "canonical": true, + "file": "data_labeling_service.delete_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "DeleteDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteDataset", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ImportData_async", + "title": "datalabeling importData Sample", + "origin": "API_DEFINITION", + "description": " Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.", + "canonical": true, + "file": "data_labeling_service.import_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 65, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ImportData", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ImportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "input_config", + "type": ".google.cloud.datalabeling.v1beta1.InputConfig" + }, + { + "name": "user_email_address", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ImportData", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ImportData", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ExportData_async", + "title": "datalabeling exportData Sample", + "origin": "API_DEFINITION", + "description": " Exports data and annotations from dataset.", + "canonical": true, + "file": "data_labeling_service.export_data.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 78, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ExportData", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ExportData", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "annotated_dataset", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + }, + { + "name": "output_config", + "type": ".google.cloud.datalabeling.v1beta1.OutputConfig" + }, + { + "name": "user_email_address", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ExportData", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ExportData", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetDataItem_async", + "title": "datalabeling getDataItem Sample", + "origin": "API_DEFINITION", + "description": " Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", + "canonical": true, + "file": "data_labeling_service.get_data_item.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetDataItem", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetDataItem", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.DataItem", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetDataItem", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetDataItem", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListDataItems_async", + "title": "datalabeling listDataItems Sample", + "origin": "API_DEFINITION", + "description": " Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_data_items.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListDataItems", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListDataItems", + "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.datalabeling.v1beta1.ListDataItemsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListDataItems", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListDataItems", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetAnnotatedDataset_async", + "title": "datalabeling getAnnotatedDataset Sample", + "origin": "API_DEFINITION", + "description": " Gets an annotated dataset by resource name.", + "canonical": true, + "file": "data_labeling_service.get_annotated_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotatedDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetAnnotatedDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.AnnotatedDataset", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetAnnotatedDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetAnnotatedDataset", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListAnnotatedDatasets_async", + "title": "datalabeling listAnnotatedDatasets Sample", + "origin": "API_DEFINITION", + "description": " Lists annotated datasets for a dataset. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_annotated_datasets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotatedDatasets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListAnnotatedDatasets", + "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.datalabeling.v1beta1.ListAnnotatedDatasetsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListAnnotatedDatasets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListAnnotatedDatasets", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_DeleteAnnotatedDataset_async", + "title": "datalabeling deleteAnnotatedDataset Sample", + "origin": "API_DEFINITION", + "description": " Deletes an annotated dataset by resource name.", + "canonical": true, + "file": "data_labeling_service.delete_annotated_dataset.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 55, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAnnotatedDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteAnnotatedDataset", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "DeleteAnnotatedDataset", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteAnnotatedDataset", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_LabelImage_async", + "title": "datalabeling labelImage Sample", + "origin": "API_DEFINITION", + "description": " Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", + "canonical": true, + "file": "data_labeling_service.label_image.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LabelImage", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelImage", + "async": true, + "parameters": [ + { + "name": "image_classification_config", + "type": ".google.cloud.datalabeling.v1beta1.ImageClassificationConfig" + }, + { + "name": "bounding_poly_config", + "type": ".google.cloud.datalabeling.v1beta1.BoundingPolyConfig" + }, + { + "name": "polyline_config", + "type": ".google.cloud.datalabeling.v1beta1.PolylineConfig" + }, + { + "name": "segmentation_config", + "type": ".google.cloud.datalabeling.v1beta1.SegmentationConfig" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "basic_config", + "type": ".google.cloud.datalabeling.v1beta1.HumanAnnotationConfig" + }, + { + "name": "feature", + "type": ".google.cloud.datalabeling.v1beta1.LabelImageRequest.Feature" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "LabelImage", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelImage", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_LabelVideo_async", + "title": "datalabeling labelVideo Sample", + "origin": "API_DEFINITION", + "description": " Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", + "canonical": true, + "file": "data_labeling_service.label_video.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 89, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LabelVideo", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelVideo", + "async": true, + "parameters": [ + { + "name": "video_classification_config", + "type": ".google.cloud.datalabeling.v1beta1.VideoClassificationConfig" + }, + { + "name": "object_detection_config", + "type": ".google.cloud.datalabeling.v1beta1.ObjectDetectionConfig" + }, + { + "name": "object_tracking_config", + "type": ".google.cloud.datalabeling.v1beta1.ObjectTrackingConfig" + }, + { + "name": "event_config", + "type": ".google.cloud.datalabeling.v1beta1.EventConfig" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "basic_config", + "type": ".google.cloud.datalabeling.v1beta1.HumanAnnotationConfig" + }, + { + "name": "feature", + "type": ".google.cloud.datalabeling.v1beta1.LabelVideoRequest.Feature" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "LabelVideo", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelVideo", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_LabelText_async", + "title": "datalabeling labelText Sample", + "origin": "API_DEFINITION", + "description": " Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", + "canonical": true, + "file": "data_labeling_service.label_text.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 77, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "LabelText", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelText", + "async": true, + "parameters": [ + { + "name": "text_classification_config", + "type": ".google.cloud.datalabeling.v1beta1.TextClassificationConfig" + }, + { + "name": "text_entity_extraction_config", + "type": ".google.cloud.datalabeling.v1beta1.TextEntityExtractionConfig" + }, + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "basic_config", + "type": ".google.cloud.datalabeling.v1beta1.HumanAnnotationConfig" + }, + { + "name": "feature", + "type": ".google.cloud.datalabeling.v1beta1.LabelTextRequest.Feature" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "LabelText", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.LabelText", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetExample_async", + "title": "datalabeling getExample Sample", + "origin": "API_DEFINITION", + "description": " Gets an example by resource name, including both data and annotation.", + "canonical": true, + "file": "data_labeling_service.get_example.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetExample", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetExample", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + }, + { + "name": "filter", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.Example", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetExample", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetExample", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListExamples_async", + "title": "datalabeling listExamples Sample", + "origin": "API_DEFINITION", + "description": " Lists examples in an annotated dataset. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_examples.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 75, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListExamples", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListExamples", + "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.datalabeling.v1beta1.ListExamplesResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListExamples", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListExamples", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_CreateAnnotationSpecSet_async", + "title": "datalabeling createAnnotationSpecSet Sample", + "origin": "API_DEFINITION", + "description": " Creates an annotation spec set by providing a set of labels.", + "canonical": true, + "file": "data_labeling_service.create_annotation_spec_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 61, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateAnnotationSpecSet", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "annotation_spec_set", + "type": ".google.cloud.datalabeling.v1beta1.AnnotationSpecSet" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.AnnotationSpecSet", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "CreateAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateAnnotationSpecSet", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetAnnotationSpecSet_async", + "title": "datalabeling getAnnotationSpecSet Sample", + "origin": "API_DEFINITION", + "description": " Gets an annotation spec set by resource name.", + "canonical": true, + "file": "data_labeling_service.get_annotation_spec_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetAnnotationSpecSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.AnnotationSpecSet", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetAnnotationSpecSet", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListAnnotationSpecSets_async", + "title": "datalabeling listAnnotationSpecSets Sample", + "origin": "API_DEFINITION", + "description": " Lists annotation spec sets for a project. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_annotation_spec_sets.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListAnnotationSpecSets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListAnnotationSpecSets", + "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.datalabeling.v1beta1.ListAnnotationSpecSetsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListAnnotationSpecSets", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListAnnotationSpecSets", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_DeleteAnnotationSpecSet_async", + "title": "datalabeling deleteAnnotationSpecSet Sample", + "origin": "API_DEFINITION", + "description": " Deletes an annotation spec set by resource name.", + "canonical": true, + "file": "data_labeling_service.delete_annotation_spec_set.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteAnnotationSpecSet", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "DeleteAnnotationSpecSet", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteAnnotationSpecSet", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_CreateInstruction_async", + "title": "datalabeling createInstruction Sample", + "origin": "API_DEFINITION", + "description": " Creates an instruction for how data should be labeled.", + "canonical": true, + "file": "data_labeling_service.create_instruction.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 60, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateInstruction", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "instruction", + "type": ".google.cloud.datalabeling.v1beta1.Instruction" + } + ], + "resultType": ".google.longrunning.Operation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "CreateInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateInstruction", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetInstruction_async", + "title": "datalabeling getInstruction Sample", + "origin": "API_DEFINITION", + "description": " Gets an instruction by resource name.", + "canonical": true, + "file": "data_labeling_service.get_instruction.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetInstruction", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.Instruction", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetInstruction", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListInstructions_async", + "title": "datalabeling listInstructions Sample", + "origin": "API_DEFINITION", + "description": " Lists instructions for a project. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_instructions.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 73, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListInstructions", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListInstructions", + "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.datalabeling.v1beta1.ListInstructionsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListInstructions", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListInstructions", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_DeleteInstruction_async", + "title": "datalabeling deleteInstruction Sample", + "origin": "API_DEFINITION", + "description": " Deletes an instruction object by resource name.", + "canonical": true, + "file": "data_labeling_service.delete_instruction.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteInstruction", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "DeleteInstruction", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteInstruction", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetEvaluation_async", + "title": "datalabeling getEvaluation Sample", + "origin": "API_DEFINITION", + "description": " Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).", + "canonical": true, + "file": "data_labeling_service.get_evaluation.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEvaluation", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetEvaluation", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.Evaluation", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetEvaluation", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetEvaluation", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_SearchEvaluations_async", + "title": "datalabeling searchEvaluations Sample", + "origin": "API_DEFINITION", + "description": " Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.", + "canonical": true, + "file": "data_labeling_service.search_evaluations.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 101, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchEvaluations", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations", + "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.datalabeling.v1beta1.SearchEvaluationsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "SearchEvaluations", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_SearchExampleComparisons_async", + "title": "datalabeling searchExampleComparisons Sample", + "origin": "API_DEFINITION", + "description": " Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.", + "canonical": true, + "file": "data_labeling_service.search_example_comparisons.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 71, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "SearchExampleComparisons", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.SearchExampleComparisons", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "page_size", + "type": "TYPE_INT32" + }, + { + "name": "page_token", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "SearchExampleComparisons", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.SearchExampleComparisons", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_CreateEvaluationJob_async", + "title": "datalabeling createEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Creates an evaluation job.", + "canonical": true, + "file": "data_labeling_service.create_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 59, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "CreateEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateEvaluationJob", + "async": true, + "parameters": [ + { + "name": "parent", + "type": "TYPE_STRING" + }, + { + "name": "job", + "type": ".google.cloud.datalabeling.v1beta1.EvaluationJob" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.EvaluationJob", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "CreateEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.CreateEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_UpdateEvaluationJob_async", + "title": "datalabeling updateEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Updates an evaluation job. You can only update certain fields of the job's [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.EvaluationJobConfig]: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.", + "canonical": true, + "file": "data_labeling_service.update_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 63, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "UpdateEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.UpdateEvaluationJob", + "async": true, + "parameters": [ + { + "name": "evaluation_job", + "type": ".google.cloud.datalabeling.v1beta1.EvaluationJob" + }, + { + "name": "update_mask", + "type": ".google.protobuf.FieldMask" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.EvaluationJob", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "UpdateEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.UpdateEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_GetEvaluationJob_async", + "title": "datalabeling getEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Gets an evaluation job by resource name.", + "canonical": true, + "file": "data_labeling_service.get_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "GetEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetEvaluationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.cloud.datalabeling.v1beta1.EvaluationJob", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "GetEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.GetEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_PauseEvaluationJob_async", + "title": "datalabeling pauseEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", + "canonical": true, + "file": "data_labeling_service.pause_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "PauseEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.PauseEvaluationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "PauseEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.PauseEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ResumeEvaluationJob_async", + "title": "datalabeling resumeEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.", + "canonical": true, + "file": "data_labeling_service.resume_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ResumeEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ResumeEvaluationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ResumeEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ResumeEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_DeleteEvaluationJob_async", + "title": "datalabeling deleteEvaluationJob Sample", + "origin": "API_DEFINITION", + "description": " Stops and deletes an evaluation job.", + "canonical": true, + "file": "data_labeling_service.delete_evaluation_job.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 54, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "DeleteEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteEvaluationJob", + "async": true, + "parameters": [ + { + "name": "name", + "type": "TYPE_STRING" + } + ], + "resultType": ".google.protobuf.Empty", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "DeleteEvaluationJob", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.DeleteEvaluationJob", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + }, + { + "regionTag": "datalabeling_v1beta1_generated_DataLabelingService_ListEvaluationJobs_async", + "title": "datalabeling listEvaluationJobs Sample", + "origin": "API_DEFINITION", + "description": " Lists all evaluation jobs within a project with possible filters. Pagination is supported.", + "canonical": true, + "file": "data_labeling_service.list_evaluation_jobs.js", + "language": "JAVASCRIPT", + "segments": [ + { + "start": 25, + "end": 80, + "type": "FULL" + } + ], + "clientMethod": { + "shortName": "ListEvaluationJobs", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListEvaluationJobs", + "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.datalabeling.v1beta1.ListEvaluationJobsResponse", + "client": { + "shortName": "DataLabelingServiceClient", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingServiceClient" + }, + "method": { + "shortName": "ListEvaluationJobs", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService.ListEvaluationJobs", + "service": { + "shortName": "DataLabelingService", + "fullName": "google.cloud.datalabeling.v1beta1.DataLabelingService" + } + } + } + } + ] +} \ No newline at end of file diff --git a/packages/google-cloud-datalabeling/samples/package.json b/packages/google-cloud-datalabeling/samples/package.json index 19b5936eadf..96544704247 100644 --- a/packages/google-cloud-datalabeling/samples/package.json +++ b/packages/google-cloud-datalabeling/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-datalabeling/src/v1beta1/data_labeling_service_client.ts b/packages/google-cloud-datalabeling/src/v1beta1/data_labeling_service_client.ts index 621ef807067..e3419c7e9cc 100644 --- a/packages/google-cloud-datalabeling/src/v1beta1/data_labeling_service_client.ts +++ b/packages/google-cloud-datalabeling/src/v1beta1/data_labeling_service_client.ts @@ -547,9 +547,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Dataset | Dataset}. - * 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.datalabeling.v1beta1.Dataset|Dataset}. + * 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/data_labeling_service.create_dataset.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_CreateDataset_async @@ -645,9 +644,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Dataset | Dataset}. - * 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.datalabeling.v1beta1.Dataset|Dataset}. + * 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/data_labeling_service.get_dataset.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetDataset_async @@ -737,9 +735,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.delete_dataset.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_DeleteDataset_async @@ -836,9 +833,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.DataItem | DataItem}. - * 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.datalabeling.v1beta1.DataItem|DataItem}. + * 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/data_labeling_service.get_data_item.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetDataItem_async @@ -929,9 +925,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.AnnotatedDataset | AnnotatedDataset}. - * 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.datalabeling.v1beta1.AnnotatedDataset|AnnotatedDataset}. + * 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/data_labeling_service.get_annotated_dataset.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetAnnotatedDataset_async @@ -1028,9 +1023,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.delete_annotated_dataset.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_DeleteAnnotatedDataset_async @@ -1135,9 +1129,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Example | Example}. - * 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.datalabeling.v1beta1.Example|Example}. + * 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/data_labeling_service.get_example.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetExample_async @@ -1231,9 +1224,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.AnnotationSpecSet | AnnotationSpecSet}. - * 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.datalabeling.v1beta1.AnnotationSpecSet|AnnotationSpecSet}. + * 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/data_labeling_service.create_annotation_spec_set.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_CreateAnnotationSpecSet_async @@ -1333,9 +1325,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.AnnotationSpecSet | AnnotationSpecSet}. - * 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.datalabeling.v1beta1.AnnotationSpecSet|AnnotationSpecSet}. + * 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/data_labeling_service.get_annotation_spec_set.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetAnnotationSpecSet_async @@ -1431,9 +1422,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.delete_annotation_spec_set.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_DeleteAnnotationSpecSet_async @@ -1533,9 +1523,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Instruction | Instruction}. - * 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.datalabeling.v1beta1.Instruction|Instruction}. + * 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/data_labeling_service.get_instruction.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetInstruction_async @@ -1631,9 +1620,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.delete_instruction.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_DeleteInstruction_async @@ -1720,7 +1708,7 @@ export class DataLabelingServiceClient { } /** * Gets an evaluation by resource name (to search, use - * {@link google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations|projects.evaluations.search}). + * {@link protos.google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations|projects.evaluations.search}). * * @param {Object} request * The request object that will be sent. @@ -1731,9 +1719,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Evaluation | Evaluation}. - * 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.datalabeling.v1beta1.Evaluation|Evaluation}. + * 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/data_labeling_service.get_evaluation.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetEvaluation_async @@ -1831,9 +1818,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob}. - * 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.datalabeling.v1beta1.EvaluationJob|EvaluationJob}. + * 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/data_labeling_service.create_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_CreateEvaluationJob_async @@ -1920,7 +1906,7 @@ export class DataLabelingServiceClient { } /** * Updates an evaluation job. You can only update certain fields of the job's - * {@link google.cloud.datalabeling.v1beta1.EvaluationJobConfig|EvaluationJobConfig}: `humanAnnotationConfig.instruction`, + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJobConfig|EvaluationJobConfig}: `humanAnnotationConfig.instruction`, * `exampleCount`, and `exampleSamplePercentage`. * * If you want to change any other aspect of the evaluation job, you must @@ -1943,9 +1929,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob}. - * 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.datalabeling.v1beta1.EvaluationJob|EvaluationJob}. + * 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/data_labeling_service.update_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_UpdateEvaluationJob_async @@ -2042,9 +2027,8 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob}. - * 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.datalabeling.v1beta1.EvaluationJob|EvaluationJob}. + * 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/data_labeling_service.get_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_GetEvaluationJob_async @@ -2142,9 +2126,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.pause_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_PauseEvaluationJob_async @@ -2242,9 +2225,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.resume_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ResumeEvaluationJob_async @@ -2341,9 +2323,8 @@ export class DataLabelingServiceClient { * @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/data_labeling_service.delete_evaluation_job.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_DeleteEvaluationJob_async @@ -2452,8 +2433,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.import_data.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ImportData_async @@ -2548,8 +2528,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.import_data.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ImportData_async @@ -2604,8 +2583,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.export_data.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ExportData_async @@ -2700,8 +2678,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.export_data.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ExportData_async @@ -2764,8 +2741,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_image.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelImage_async @@ -2860,8 +2836,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_image.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelImage_async @@ -2924,8 +2899,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_video.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelVideo_async @@ -3020,8 +2994,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_video.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelVideo_async @@ -3076,8 +3049,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_text.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelText_async @@ -3172,8 +3144,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.label_text.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_LabelText_async @@ -3217,8 +3188,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.create_instruction.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_CreateInstruction_async @@ -3313,8 +3283,7 @@ export class DataLabelingServiceClient { * 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/data_labeling_service.create_instruction.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_CreateInstruction_async @@ -3358,20 +3327,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListDatasets] call. * Returns the first page if empty. * @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.datalabeling.v1beta1.Dataset | Dataset}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.Dataset|Dataset}. * 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 `listDatasetsAsync()` * 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. */ listDatasets( @@ -3464,19 +3432,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListDatasets] call. * Returns the first page if empty. * @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.datalabeling.v1beta1.Dataset | Dataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.Dataset|Dataset} 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 `listDatasetsAsync()` * 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. */ listDatasetsStream( @@ -3518,18 +3485,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDatasetsResponse.next_page_token|ListDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListDatasets] call. * Returns the first page if empty. * @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.datalabeling.v1beta1.Dataset | Dataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.Dataset|Dataset}. 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/data_labeling_service.list_datasets.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListDatasets_async @@ -3572,20 +3538,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous * [DataLabelingService.ListDataItems] call. * Return first page if empty. * @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.datalabeling.v1beta1.DataItem | DataItem}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.DataItem|DataItem}. * 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 `listDataItemsAsync()` * 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. */ listDataItems( @@ -3678,19 +3643,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous * [DataLabelingService.ListDataItems] call. * Return first page if empty. * @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.datalabeling.v1beta1.DataItem | DataItem} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.DataItem|DataItem} 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 `listDataItemsAsync()` * 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. */ listDataItemsStream( @@ -3732,18 +3696,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListDataItemsResponse.next_page_token|ListDataItemsResponse.next_page_token} of the previous * [DataLabelingService.ListDataItems] call. * Return first page if empty. * @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.datalabeling.v1beta1.DataItem | DataItem}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.DataItem|DataItem}. 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/data_labeling_service.list_data_items.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListDataItems_async @@ -3785,20 +3748,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotatedDatasets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotatedDataset | AnnotatedDataset}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset|AnnotatedDataset}. * 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 `listAnnotatedDatasetsAsync()` * 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. */ listAnnotatedDatasets( @@ -3891,19 +3853,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotatedDatasets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotatedDataset | AnnotatedDataset} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset|AnnotatedDataset} 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 `listAnnotatedDatasetsAsync()` * 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. */ listAnnotatedDatasetsStream( @@ -3945,18 +3906,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse.next_page_token|ListAnnotatedDatasetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotatedDatasets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotatedDataset | AnnotatedDataset}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.AnnotatedDataset|AnnotatedDataset}. 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/data_labeling_service.list_annotated_datasets.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListAnnotatedDatasets_async @@ -4000,20 +3960,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous * [DataLabelingService.ListExamples] call. * Return first page if empty. * @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.datalabeling.v1beta1.Example | Example}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.Example|Example}. * 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 `listExamplesAsync()` * 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. */ listExamples( @@ -4108,19 +4067,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous * [DataLabelingService.ListExamples] call. * Return first page if empty. * @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.datalabeling.v1beta1.Example | Example} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.Example|Example} 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 `listExamplesAsync()` * 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. */ listExamplesStream( @@ -4164,18 +4122,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListExamplesResponse.next_page_token|ListExamplesResponse.next_page_token} of the previous * [DataLabelingService.ListExamples] call. * Return first page if empty. * @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.datalabeling.v1beta1.Example | Example}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.Example|Example}. 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/data_labeling_service.list_examples.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListExamples_async @@ -4217,20 +4174,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotationSpecSets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotationSpecSet | AnnotationSpecSet}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpecSet|AnnotationSpecSet}. * 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 `listAnnotationSpecSetsAsync()` * 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. */ listAnnotationSpecSets( @@ -4327,19 +4283,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotationSpecSets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotationSpecSet | AnnotationSpecSet} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpecSet|AnnotationSpecSet} 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 `listAnnotationSpecSetsAsync()` * 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. */ listAnnotationSpecSetsStream( @@ -4381,18 +4336,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse.next_page_token|ListAnnotationSpecSetsResponse.next_page_token} of the previous * [DataLabelingService.ListAnnotationSpecSets] call. * Return first page if empty. * @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.datalabeling.v1beta1.AnnotationSpecSet | AnnotationSpecSet}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpecSet|AnnotationSpecSet}. 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/data_labeling_service.list_annotation_spec_sets.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListAnnotationSpecSets_async @@ -4434,20 +4388,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous * [DataLabelingService.ListInstructions] call. * Return first page if empty. * @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.datalabeling.v1beta1.Instruction | Instruction}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.Instruction|Instruction}. * 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 `listInstructionsAsync()` * 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. */ listInstructions( @@ -4540,19 +4493,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous * [DataLabelingService.ListInstructions] call. * Return first page if empty. * @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.datalabeling.v1beta1.Instruction | Instruction} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.Instruction|Instruction} 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 `listInstructionsAsync()` * 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. */ listInstructionsStream( @@ -4594,18 +4546,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by - * {@link google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous + * {@link protos.google.cloud.datalabeling.v1beta1.ListInstructionsResponse.next_page_token|ListInstructionsResponse.next_page_token} of the previous * [DataLabelingService.ListInstructions] call. * Return first page if empty. * @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.datalabeling.v1beta1.Instruction | Instruction}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.Instruction|Instruction}. 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/data_labeling_service.list_instructions.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListInstructions_async @@ -4632,7 +4583,7 @@ export class DataLabelingServiceClient { ) as AsyncIterable; } /** - * Searches {@link google.cloud.datalabeling.v1beta1.Evaluation|evaluations} within a project. + * Searches {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|evaluations} within a project. * * @param {Object} request * The request object that will be sent. @@ -4643,21 +4594,21 @@ export class DataLabelingServiceClient { * Optional. To search evaluations, you can filter by the following: * * * evaluation_job.evaluation_job_id (the last part of - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) * * evaluation_job.model_id (the {model_name} portion - * of {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) + * of {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) * * evaluation_job.evaluation_job_run_time_start (Minimum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) * * evaluation_job.evaluation_job_run_time_end (Maximum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) - * * evaluation_job.job_state ({@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) + * * evaluation_job.job_state ({@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) * * annotation_spec.display_name (the Evaluation contains a * metric for the annotation spec with this - * {@link google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) + * {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) * * To filter by multiple critiera, use the `AND` operator or the `OR` * operator. The following examples shows a string that filters by several @@ -4677,7 +4628,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response + * {@link protos.google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response * to a previous search request. * * If you don't specify this field, the API call requests the first page of @@ -4685,14 +4636,13 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Evaluation | Evaluation}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation}. * 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 `searchEvaluationsAsync()` * 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. */ searchEvaluations( @@ -4781,21 +4731,21 @@ export class DataLabelingServiceClient { * Optional. To search evaluations, you can filter by the following: * * * evaluation_job.evaluation_job_id (the last part of - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) * * evaluation_job.model_id (the {model_name} portion - * of {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) + * of {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) * * evaluation_job.evaluation_job_run_time_start (Minimum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) * * evaluation_job.evaluation_job_run_time_end (Maximum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) - * * evaluation_job.job_state ({@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) + * * evaluation_job.job_state ({@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) * * annotation_spec.display_name (the Evaluation contains a * metric for the annotation spec with this - * {@link google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) + * {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) * * To filter by multiple critiera, use the `AND` operator or the `OR` * operator. The following examples shows a string that filters by several @@ -4815,7 +4765,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response + * {@link protos.google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response * to a previous search request. * * If you don't specify this field, the API call requests the first page of @@ -4823,13 +4773,12 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Evaluation | Evaluation} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} 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 `searchEvaluationsAsync()` * 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. */ searchEvaluationsStream( @@ -4867,21 +4816,21 @@ export class DataLabelingServiceClient { * Optional. To search evaluations, you can filter by the following: * * * evaluation_job.evaluation_job_id (the last part of - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.name|EvaluationJob.name}) * * evaluation_job.model_id (the {model_name} portion - * of {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) + * of {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) * * evaluation_job.evaluation_job_run_time_start (Minimum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) * * evaluation_job.evaluation_job_run_time_end (Maximum * threshold for the - * {@link google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation.evaluation_job_run_time|evaluationJobRunTime} that created * the evaluation) - * * evaluation_job.job_state ({@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) + * * evaluation_job.job_state ({@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}) * * annotation_spec.display_name (the Evaluation contains a * metric for the annotation spec with this - * {@link google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) + * {@link protos.google.cloud.datalabeling.v1beta1.AnnotationSpec.display_name|displayName}) * * To filter by multiple critiera, use the `AND` operator or the `OR` * operator. The following examples shows a string that filters by several @@ -4901,7 +4850,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response + * {@link protos.google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse.next_page_token|nextPageToken} of the response * to a previous search request. * * If you don't specify this field, the API call requests the first page of @@ -4909,12 +4858,11 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.Evaluation | Evaluation}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation}. 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/data_labeling_service.search_evaluations.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_SearchEvaluations_async @@ -4948,7 +4896,7 @@ export class DataLabelingServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. Name of the {@link google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example + * Required. Name of the {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example * comparisons from. Format: * * "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}" @@ -4958,7 +4906,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link SearchExampleComparisons.next_page_token|nextPageToken} of the response + * {@link protos.SearchExampleComparisons.next_page_token|nextPageToken} of the response * to a previous search rquest. * * If you don't specify this field, the API call requests the first page of @@ -4966,14 +4914,13 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison | ExampleComparison}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison|ExampleComparison}. * 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 `searchExampleComparisonsAsync()` * 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. */ searchExampleComparisons( @@ -5060,7 +5007,7 @@ export class DataLabelingServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. Name of the {@link google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example + * Required. Name of the {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example * comparisons from. Format: * * "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}" @@ -5070,7 +5017,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link SearchExampleComparisons.next_page_token|nextPageToken} of the response + * {@link protos.SearchExampleComparisons.next_page_token|nextPageToken} of the response * to a previous search rquest. * * If you don't specify this field, the API call requests the first page of @@ -5078,13 +5025,12 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison | ExampleComparison} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison|ExampleComparison} 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 `searchExampleComparisonsAsync()` * 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. */ searchExampleComparisonsStream( @@ -5116,7 +5062,7 @@ export class DataLabelingServiceClient { * @param {Object} request * The request object that will be sent. * @param {string} request.parent - * Required. Name of the {@link google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example + * Required. Name of the {@link protos.google.cloud.datalabeling.v1beta1.Evaluation|Evaluation} resource to search for example * comparisons from. Format: * * "projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}" @@ -5126,7 +5072,7 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link SearchExampleComparisons.next_page_token|nextPageToken} of the response + * {@link protos.SearchExampleComparisons.next_page_token|nextPageToken} of the response * to a previous search rquest. * * If you don't specify this field, the API call requests the first page of @@ -5134,12 +5080,11 @@ export class DataLabelingServiceClient { * @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.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison | ExampleComparison}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison|ExampleComparison}. 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/data_labeling_service.search_example_comparisons.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_SearchExampleComparisons_async @@ -5177,8 +5122,8 @@ export class DataLabelingServiceClient { * @param {string} [request.filter] * Optional. You can filter the jobs to list by model_id (also known as * model_name, as described in - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by - * evaluation job state (as described in {@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by + * evaluation job state (as described in {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter * by both criteria, use the `AND` operator or the `OR` operator. For example, * you can use the following string for your filter: * "evaluation_job.model_id = {model_name} AND @@ -5189,20 +5134,19 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response + * {@link protos.google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response * to the previous request. The request returns the first page if this is * empty. * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob}. + * The first element of the array is Array of {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob|EvaluationJob}. * 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 `listEvaluationJobsAsync()` * 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. */ listEvaluationJobs( @@ -5290,8 +5234,8 @@ export class DataLabelingServiceClient { * @param {string} [request.filter] * Optional. You can filter the jobs to list by model_id (also known as * model_name, as described in - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by - * evaluation job state (as described in {@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by + * evaluation job state (as described in {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter * by both criteria, use the `AND` operator or the `OR` operator. For example, * you can use the following string for your filter: * "evaluation_job.model_id = {model_name} AND @@ -5302,19 +5246,18 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response + * {@link protos.google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response * to the previous request. The request returns the first page if this is * empty. * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob} on 'data' event. + * An object stream which emits an object representing {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob|EvaluationJob} 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 `listEvaluationJobsAsync()` * 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. */ listEvaluationJobsStream( @@ -5351,8 +5294,8 @@ export class DataLabelingServiceClient { * @param {string} [request.filter] * Optional. You can filter the jobs to list by model_id (also known as * model_name, as described in - * {@link google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by - * evaluation job state (as described in {@link google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.model_version|EvaluationJob.modelVersion}) or by + * evaluation job state (as described in {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob.state|EvaluationJob.state}). To filter * by both criteria, use the `AND` operator or the `OR` operator. For example, * you can use the following string for your filter: * "evaluation_job.model_id = {model_name} AND @@ -5363,18 +5306,17 @@ export class DataLabelingServiceClient { * @param {string} [request.pageToken] * Optional. A token identifying a page of results for the server to return. * Typically obtained by the - * {@link google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response + * {@link protos.google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse.next_page_token|nextPageToken} in the response * to the previous request. The request returns the first page if this is * empty. * @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.datalabeling.v1beta1.EvaluationJob | EvaluationJob}. The API will be called under the hood as needed, once per the page, + * {@link protos.google.cloud.datalabeling.v1beta1.EvaluationJob|EvaluationJob}. 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/data_labeling_service.list_evaluation_jobs.js * region_tag:datalabeling_v1beta1_generated_DataLabelingService_ListEvaluationJobs_async